README.md

   1 # Clippy
   2
   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)
   5
   6 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
   7
   8 [There are over 400 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
   9
  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.
  12
  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         |
  23
  24 More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
  25
  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.
  29
  30 Table of contents:
  31
  32 *   [Usage instructions](#usage)
  33 *   [Configuration](#configuration)
  34 *   [Contributing](#contributing)
  35 *   [License](#license)
  36
  37 ## Usage
  38
  39 Below are instructions on how to use Clippy as a subcommand, compiled from source
  40 or in Travis CI.
  41
  42 ### As a cargo subcommand (`cargo clippy`)
  43
  44 One way to use Clippy is by installing Clippy through rustup as a cargo
  45 subcommand.
  46
  47 #### Step 1: Install rustup
  48
  49 You can install [rustup](https://rustup.rs/) on supported platforms. This will help
  50 us install Clippy and its dependencies.
  51
  52 If you already have rustup installed, update to ensure you have the latest
  53 rustup and compiler:
  54
  55 ```terminal
  56 rustup update
  57 ```
  58
  59 #### Step 2: Install Clippy
  60
  61 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
  62
  63 ```terminal
  64 rustup component add clippy
  65 ```
  66 If it says that it can't find the `clippy` component, please run `rustup self update`.
  67
  68 #### Step 3: Run Clippy
  69
  70 Now you can run Clippy by invoking the following command:
  71
  72 ```terminal
  73 cargo clippy
  74 ```
  75
  76 #### Automatically applying Clippy suggestions
  77
  78 Clippy can automatically apply some lint suggestions.
  79 Note that this is still experimental and only supported on the nightly channel:
  80
  81 ```terminal
  82 cargo clippy --fix -Z unstable-options
  83 ```
  84
  85 #### Workspaces
  86
  87 All the usual workspace options should work with Clippy. For example the following command
  88 will run Clippy on the `example` crate:
  89
  90 ```terminal
  91 cargo clippy -p example
  92 ```
  93
  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:
  96
  97 ```terminal
  98 cargo clippy -p example -- --no-deps
  99 ```
 100
 101 ### Running Clippy from the command line without installing it
 102
 103 To have cargo compile your crate with Clippy without Clippy installation
 104 in your code, you can use:
 105
 106 ```terminal
 107 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
 108 ```
 109
 110 *Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
 111
 112 ### Travis CI
 113
 114 You can add Clippy to Travis CI in the same way you use it locally:
 115
 116 ```yml
 117 language: rust
 118 rust:
 119   - stable
 120   - beta
 121 before_script:
 122   - rustup component add clippy
 123 script:
 124   - cargo clippy
 125   # if you want the build job to fail when encountering warnings, use
 126   - cargo clippy -- -D warnings
 127   # in order to also check tests and non-default crate features, use
 128   - cargo clippy --all-targets --all-features -- -D warnings
 129   - cargo test
 130   # etc.
 131 ```
 132
 133 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
 134 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
 135 an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
 136 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
 137
 138 ## Configuration
 139
 140 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable =
 141 value` mapping eg.
 142
 143 ```toml
 144 blacklisted-names = ["toto", "tata", "titi"]
 145 cognitive-complexity-threshold = 30
 146 ```
 147
 148 See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which
 149 lints can be configured and the meaning of the variables.
 150
 151 To deactivate the “for further information visit *lint-link*” message you can
 152 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 153
 154 ### Allowing/denying lints
 155
 156 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 157
 158 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 159
 160 *   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
 161     `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
 162     lints prone to false positives.
 163
 164 *   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
 165
 166 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
 167
 168 Note: `allow` means to suppress the lint for your code. With `warn` the lint
 169 will only emit a warning, while with `deny` the lint will emit an error, when
 170 triggering for your code. An error causes clippy to exit with an error code, so
 171 is useful in scripts like CI/CD.
 172
 173 If you do not want to include your lint levels in your code, you can globally
 174 enable/disable lints by passing extra flags to Clippy during the run:
 175
 176 To allow `lint_name`, run
 177
 178 ```terminal
 179 cargo clippy -- -A clippy::lint_name
 180 ```
 181
 182 And to warn on `lint_name`, run
 183
 184 ```terminal
 185 cargo clippy -- -W clippy::lint_name
 186 ```
 187
 188 This also works with lint groups. For example you
 189 can run Clippy with warnings for all lints enabled:
 190 ```terminal
 191 cargo clippy -- -W clippy::pedantic
 192 ```
 193
 194 If you care only about a single lint, you can allow all others and then explicitly warn on
 195 the lint(s) you are interested in:
 196 ```terminal
 197 cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
 198 ```
 199
 200 ### Specifying the minimum supported Rust version
 201
 202 Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
 203 specifying the minimum supported Rust version (MSRV) in the clippy configuration file.
 204
 205 ```toml
 206 msrv = "1.30.0"
 207 ```
 208
 209 The MSRV can also be specified as an inner attribute, like below.
 210
 211 ```rust
 212 #![feature(custom_inner_attributes)]
 213 #![clippy::msrv = "1.30.0"]
 214
 215 fn main() {
 216   ...
 217 }
 218 ```
 219
 220 You can also omit the patch version when specifying the MSRV, so `msrv = 1.30`
 221 is equivalent to `msrv = 1.30.0`.
 222
 223 Note: `custom_inner_attributes` is an unstable feature so it has to be enabled explicitly.
 224
 225 Lints that recognize this configuration option can be found [here](https://rust-lang.github.io/rust-clippy/master/index.html#msrv)
 226
 227 ## Contributing
 228
 229 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).
 230
 231 ## License
 232
 233 Copyright 2014-2020 The Rust Project Developers
 234
 235 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 236 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
 237 <LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your
 238 option. Files in the project may not be
 239 copied, modified, or distributed except according to those terms.