3 [![Clippy Test](https://github.com/rust-lang/rust-clippy/workflows/Clippy%20Test/badge.svg?branch=auto&event=push)](https://github.com/rust-lang/rust-clippy/actions?query=workflow%3A%22Clippy+Test%22+event%3Apush+branch%3Aauto)
4 [![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
6 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
8 [There are over 400 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
10 Lints are divided into categories, each with a default [lint level](https://doc.rust-lang.org/rustc/lints/levels.html).
11 You can choose how much Clippy is supposed to ~~annoy~~ help you by changing the lint level by category.
13 | Category | Description | Default level |
14 | --------------------- | ----------------------------------------------------------------------- | ------------- |
15 | `clippy::all` | all lints that are on by default (correctness, style, complexity, perf) | **warn/deny** |
16 | `clippy::correctness` | code that is outright wrong or very useless | **deny** |
17 | `clippy::style` | code that should be written in a more idiomatic way | **warn** |
18 | `clippy::complexity` | code that does something simple but in a complex way | **warn** |
19 | `clippy::perf` | code that can be written to run faster | **warn** |
20 | `clippy::pedantic` | lints which are rather strict or might have false positives | allow |
21 | `clippy::nursery` | new lints that are still under development | allow |
22 | `clippy::cargo` | lints for the cargo manifest | allow |
24 More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
26 The [lint list](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are
27 for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used
28 very selectively, if at all.
32 * [Usage instructions](#usage)
33 * [Configuration](#configuration)
34 * [Contributing](#contributing)
39 Below are instructions on how to use Clippy as a subcommand, compiled from source
42 ### As a cargo subcommand (`cargo clippy`)
44 One way to use Clippy is by installing Clippy through rustup as a cargo
47 #### Step 1: Install rustup
49 You can install [rustup](https://rustup.rs/) on supported platforms. This will help
50 us install Clippy and its dependencies.
52 If you already have rustup installed, update to ensure you have the latest
59 #### Step 2: Install Clippy
61 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
64 rustup component add clippy
66 If it says that it can't find the `clippy` component, please run `rustup self update`.
68 #### Step 3: Run Clippy
70 Now you can run Clippy by invoking the following command:
76 #### Automatically applying Clippy suggestions
78 Clippy can automatically apply some lint suggestions.
79 Note that this is still experimental and only supported on the nightly channel:
82 cargo clippy --fix -Z unstable-options
87 All the usual workspace options should work with Clippy. For example the following command
88 will run Clippy on the `example` crate:
91 cargo clippy -p example
94 As with `cargo check`, this includes dependencies that are members of the workspace, like path dependencies.
95 If you want to run Clippy **only** on the given crate, use the `--no-deps` option like this:
98 cargo clippy -p example -- --no-deps
101 ### As a rustc replacement (`clippy-driver`)
103 Clippy can also be used in projects that do not use cargo. To do so, you will need to replace
104 your `rustc` compilation commands with `clippy-driver`. For example, if your project runs:
107 rustc --edition 2018 -Cpanic=abort foo.rs
110 Then, to enable Clippy, you will need to call:
113 clippy-driver --edition 2018 -Cpanic=abort foo.rs
116 Note that `rustc` will still run, i.e. it will still emit the output files it normally does.
120 You can add Clippy to Travis CI in the same way you use it locally:
128 - rustup component add clippy
131 # if you want the build job to fail when encountering warnings, use
132 - cargo clippy -- -D warnings
133 # in order to also check tests and non-default crate features, use
134 - cargo clippy --all-targets --all-features -- -D warnings
139 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
140 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
141 an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
142 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
146 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable =
150 blacklisted-names = ["toto", "tata", "titi"]
151 cognitive-complexity-threshold = 30
154 See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which
155 lints can be configured and the meaning of the variables.
157 To deactivate the “for further information visit *lint-link*” message you can
158 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
160 ### Allowing/denying lints
162 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
164 * the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
166 * all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
167 `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
168 lints prone to false positives.
170 * only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
172 * `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
174 Note: `allow` means to suppress the lint for your code. With `warn` the lint
175 will only emit a warning, while with `deny` the lint will emit an error, when
176 triggering for your code. An error causes clippy to exit with an error code, so
177 is useful in scripts like CI/CD.
179 If you do not want to include your lint levels in your code, you can globally
180 enable/disable lints by passing extra flags to Clippy during the run:
182 To allow `lint_name`, run
185 cargo clippy -- -A clippy::lint_name
188 And to warn on `lint_name`, run
191 cargo clippy -- -W clippy::lint_name
194 This also works with lint groups. For example you
195 can run Clippy with warnings for all lints enabled:
197 cargo clippy -- -W clippy::pedantic
200 If you care only about a single lint, you can allow all others and then explicitly warn on
201 the lint(s) you are interested in:
203 cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
206 ### Specifying the minimum supported Rust version
208 Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
209 specifying the minimum supported Rust version (MSRV) in the clippy configuration file.
215 The MSRV can also be specified as an inner attribute, like below.
218 #![feature(custom_inner_attributes)]
219 #![clippy::msrv = "1.30.0"]
226 You can also omit the patch version when specifying the MSRV, so `msrv = 1.30`
227 is equivalent to `msrv = 1.30.0`.
229 Note: `custom_inner_attributes` is an unstable feature so it has to be enabled explicitly.
231 Lints that recognize this configuration option can be found [here](https://rust-lang.github.io/rust-clippy/master/index.html#msrv)
235 If you want to contribute to Clippy, you can find more information in [CONTRIBUTING.md](https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md).
239 Copyright 2014-2020 The Rust Project Developers
241 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
242 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
243 <LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your
244 option. Files in the project may not be
245 copied, modified, or distributed except according to those terms.