clippy_dev/README.md

   1 ## Clippy-dev is a tool to ease clippys development, similar to `rustc`s `x.py`.
   2
   3 Functionalities (incomplete):
   4
   5 # lintcheck
   6 Runs clippy on a fixed set of crates read from `clippy_dev/lintcheck_crates.toml`
   7 and saves logs of the lint warnings into the repo.
   8 We can then check the diff and spot new or disappearing warnings.
   9
  10 From the repo root, run:
  11 ````
  12 cargo run --target-dir clippy_dev/target --package clippy_dev \
  13 --bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
  14 ````
  15 or
  16 ````
  17 cargo dev-lintcheck
  18 ````
  19
  20 By default the logs will be saved into `lintcheck-logs/lintcheck_crates_logs.txt`.
  21
  22 You can set a custom sources.toml by adding `--crates-toml custom.toml`
  23 where `custom.toml` must be a relative path from the repo root.
  24
  25 The results will then be saved to `lintcheck-logs/custom_logs.toml`.
  26