3 [![Build Status](https://travis-ci.com/rust-lang/rust-clippy.svg?branch=master)](https://travis-ci.com/rust-lang/rust-clippy)
4 [![Windows Build status](https://ci.appveyor.com/api/projects/status/id677xpw1dguo7iw?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/rust-clippy)
5 [![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)
6 [![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
8 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
10 [There are 355 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
12 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
14 * `clippy::all` (everything that is on by default: all the categories below except for `nursery`, `pedantic`, and `cargo`)
15 * `clippy::correctness` (code that is just **outright wrong** or **very very useless**, causes hard errors by default)
16 * `clippy::style` (code that should be written in a more idiomatic way)
17 * `clippy::complexity` (code that does something simple but in a complex way)
18 * `clippy::perf` (code that can be written in a faster way)
19 * `clippy::pedantic` (lints which are rather strict, off by default)
20 * `clippy::nursery` (new lints that aren't quite ready yet, off by default)
21 * `clippy::cargo` (checks against the cargo manifest, off by default)
23 More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
25 Only the following of those categories are enabled by default:
28 * `clippy::correctness`
29 * `clippy::complexity`
32 Other categories need to be enabled in order for their lints to be executed.
34 The [lint list](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are
35 for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used
36 very selectively, if at all.
40 * [Usage instructions](#usage)
41 * [Configuration](#configuration)
42 * [Contributing](#contributing)
47 Since this is a tool for helping the developer of a library or application
48 write better code, it is recommended not to include Clippy as a hard dependency.
49 Options include using it as an optional dependency, as a cargo subcommand, or
50 as an included feature during build. These options are detailed below.
52 ### As a cargo subcommand (`cargo clippy`)
54 One way to use Clippy is by installing Clippy through rustup as a cargo
57 #### Step 1: Install rustup
59 You can install [rustup](https://rustup.rs/) on supported platforms. This will help
60 us install Clippy and its dependencies.
62 If you already have rustup installed, update to ensure you have the latest
69 #### Step 2: Install Clippy
71 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
74 rustup component add clippy
76 If it says that it can't find the `clippy` component, please run `rustup self update`.
78 #### Step 3: Run Clippy
80 Now you can run Clippy by invoking the following command:
86 #### Automatically applying Clippy suggestions
88 Some Clippy lint suggestions can be automatically applied by `cargo fix`.
89 Note that this is still experimental and only supported on the nightly channel:
92 cargo fix -Z unstable-options --clippy
95 ### Running Clippy from the command line without installing it
97 To have cargo compile your crate with Clippy without Clippy installation
98 in your code, you can use:
101 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
104 *Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
108 You can add Clippy to Travis CI in the same way you use it locally:
116 - rustup component add clippy
119 # if you want the build job to fail when encountering warnings, use
120 - cargo clippy -- -D warnings
121 # in order to also check tests and non-default crate features, use
122 - cargo clippy --all-targets --all-features -- -D warnings
127 If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
128 In this case you can try to conditionally install Clippy from the Git repo.
135 - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
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: `deny` produces errors instead of warnings.
176 If you do not want to include your lint levels in your code, you can globally enable/disable lints by passing extra
177 flags to Clippy during the run: `cargo clippy -- -A clippy::lint_name` will run Clippy with `lint_name` disabled and
178 `cargo clippy -- -W clippy::lint_name` will run it with that enabled. This also works with lint groups. For example you
179 can run Clippy with warnings for all lints enabled: `cargo clippy -- -W clippy::pedantic`
183 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).
187 Copyright 2014-2019 The Rust Project Developers
189 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
190 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
191 <LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your
192 option. Files in the project may not be
193 copied, modified, or distributed except according to those terms.