3 The Clippy Dev Tool is a tool to ease Clippy development, similar to `rustc`s
6 Functionalities (incomplete):
10 Runs clippy on a fixed set of crates read from
11 `clippy_dev/lintcheck_crates.toml` and saves logs of the lint warnings into the
12 repo. We can then check the diff and spot new or disappearing warnings.
14 From the repo root, run:
17 cargo run --target-dir clippy_dev/target --package clippy_dev \
18 --bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
27 By default the logs will be saved into
28 `lintcheck-logs/lintcheck_crates_logs.txt`.
30 You can set a custom sources.toml by adding `--crates-toml custom.toml` or using
31 `LINTCHECK_TOML="custom.toml"` where `custom.toml` must be a relative path from
34 The results will then be saved to `lintcheck-logs/custom_logs.toml`.
36 ### Configuring the Crate Sources
38 The sources to check are saved in a `toml` file. There are three types of
44 bitflags = {name = "bitflags", versions = ['1.2.1']}
46 Requires a "name" and one or multiple "versions" to be checked.
50 puffin = {name = "puffin", git_url = "https://github.com/EmbarkStudios/puffin", git_hash = "02dd4a3"}
52 Requires a name, the url to the repo and unique identifier of a commit,
53 branch or tag which is checked out before linting. There is no way to always
54 check `HEAD` because that would lead to changing lint-results as the repo
55 would get updated. If `git_url` or `git_hash` is missing, an error will be
60 clippy = {name = "clippy", path = "/home/user/clippy"}
62 For when you want to add a repository that is not published yet.
64 #### Command Line Options (optional)
67 bitflags = {name = "bitflags", versions = ['1.2.1'], options = ['-Wclippy::pedantic', '-Wclippy::cargo']}
70 It is possible to specify command line options for each crate. This makes it
71 possible to only check a crate for certain lint groups. If no options are
72 specified, the lint groups `clippy::all`, `clippy::pedantic`, and
73 `clippy::cargo` are checked. If an empty array is specified only `clippy::all`
76 **Note:** `-Wclippy::all` is always enabled by default, unless `-Aclippy::all`
77 is explicitly specified in the options.