3 The Clippy Dev Tool is a tool to ease Clippy development, similar to `rustc`s `x.py`.
5 Functionalities (incomplete):
8 Runs clippy on a fixed set of crates read from `clippy_dev/lintcheck_crates.toml`
9 and saves logs of the lint warnings into the repo.
10 We can then check the diff and spot new or disappearing warnings.
12 From the repo root, run:
14 cargo run --target-dir clippy_dev/target --package clippy_dev \
15 --bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
22 By default the logs will be saved into `lintcheck-logs/lintcheck_crates_logs.txt`.
24 You can set a custom sources.toml by adding `--crates-toml custom.toml` or using `LINTCHECK_TOML="custom.toml"`
25 where `custom.toml` must be a relative path from the repo root.
27 The results will then be saved to `lintcheck-logs/custom_logs.toml`.
29 ### Configuring the Crate Sources
31 The sources to check are saved in a `toml` file.
32 There are three types of sources.
35 bitflags = {name = "bitflags", versions = ['1.2.1']}
37 Requires a "name" and one or multiple "versions" to be checked.
41 puffin = {name = "puffin", git_url = "https://github.com/EmbarkStudios/puffin", git_hash = "02dd4a3"}
43 Requires a name, the url to the repo and unique identifier of a commit,
44 branch or tag which is checked out before linting.
45 There is no way to always check `HEAD` because that would lead to changing lint-results as the repo would get updated.
46 If `git_url` or `git_hash` is missing, an error will be thrown.
50 clippy = {name = "clippy", path = "/home/user/clippy"}
52 For when you want to add a repository that is not published yet.