Skip to content

Latest commit

 

History

9 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

driftcheck

Detect version drift between docs and toolchain files.

README.md says Rust 1.93.0 but rust-toolchain.toml pins 1.96.1? CONTRIBUTING.md says Node 18 but package.json engines says 24? go.mod says 1.23 but docs say 1.21? driftcheck catches it before your contributors hit a build failure.

pip install git+https://github.com/yunaremaia/driftcheck.git
driftcheck           # scan current repo
driftcheck --json    # machine-readable
driftcheck --fix     # auto-fix drifts in documentation files

Checks (v0.1.4):

  • Rust: rust-toolchain.toml channel and Cargo.toml rust-version vs README.md / docs/README*.md / CONTRIBUTING*.md
    • Minor-aware: channel = "1.96" matches docs that say Rust 1.96.1 (patch differences ignored); a real drift is a different major/minor.
  • Node: package.json engines.node vs README
  • Python: pyproject.toml requires-python vs README
  • Go: go.mod go directive vs README
  • Extensible: add more toolchain sources in driftcheck/detector.py

Inspired by fixing tinyhumansai/openhuman#5781 (6 READMEs drifted).

About

Detect version drift between docs and toolchain files (README vs rust-toolchain.toml etc.)

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages