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 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
  11
  12 * `clippy::all` (everything that is on by default: all the categories below except for `nursery`, `pedantic`, and `cargo`)
  13 * `clippy::correctness` (code that is just **outright wrong** or **very very useless**, causes hard errors by default)
  14 * `clippy::style` (code that should be written in a more idiomatic way)
  15 * `clippy::complexity` (code that does something simple but in a complex way)
  16 * `clippy::perf` (code that can be written in a faster way)
  17 * `clippy::pedantic` (lints which are rather strict, off by default)
  18 * `clippy::nursery` (new lints that aren't quite ready yet, off by default)
  19 * `clippy::cargo` (checks against the cargo manifest, off by default)
  20
  21 More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
  22
  23 Only the following of those categories are enabled by default:
  24
  25 * `clippy::style`
  26 * `clippy::correctness`
  27 * `clippy::complexity`
  28 * `clippy::perf`
  29
  30 Other categories need to be enabled in order for their lints to be executed.
  31
  32 The [lint list](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are
  33 for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used
  34 very selectively, if at all.
  35
  36 Table of contents:
  37
  38 *   [Usage instructions](#usage)
  39 *   [Configuration](#configuration)
  40 *   [Contributing](#contributing)
  41 *   [License](#license)
  42
  43 ## Usage
  44
  45 Below are instructions on how to use Clippy as a subcommand, compiled from source
  46 or in Travis CI.
  47
  48 ### As a cargo subcommand (`cargo clippy`)
  49
  50 One way to use Clippy is by installing Clippy through rustup as a cargo
  51 subcommand.
  52
  53 #### Step 1: Install rustup
  54
  55 You can install [rustup](https://rustup.rs/) on supported platforms. This will help
  56 us install Clippy and its dependencies.
  57
  58 If you already have rustup installed, update to ensure you have the latest
  59 rustup and compiler:
  60
  61 ```terminal
  62 rustup update
  63 ```
  64
  65 #### Step 2: Install Clippy
  66
  67 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
  68
  69 ```terminal
  70 rustup component add clippy
  71 ```
  72 If it says that it can't find the `clippy` component, please run `rustup self update`.
  73
  74 #### Step 3: Run Clippy
  75
  76 Now you can run Clippy by invoking the following command:
  77
  78 ```terminal
  79 cargo clippy
  80 ```
  81
  82 #### Automatically applying Clippy suggestions
  83
  84 Clippy can automatically apply some lint suggestions.
  85 Note that this is still experimental and only supported on the nightly channel:
  86
  87 ```terminal
  88 cargo clippy --fix -Z unstable-options
  89 ```
  90
  91 ### Running Clippy from the command line without installing it
  92
  93 To have cargo compile your crate with Clippy without Clippy installation
  94 in your code, you can use:
  95
  96 ```terminal
  97 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  98 ```
  99
 100 *Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
 101
 102 ### Travis CI
 103
 104 You can add Clippy to Travis CI in the same way you use it locally:
 105
 106 ```yml
 107 language: rust
 108 rust:
 109   - stable
 110   - beta
 111 before_script:
 112   - rustup component add clippy
 113 script:
 114   - cargo clippy
 115   # if you want the build job to fail when encountering warnings, use
 116   - cargo clippy -- -D warnings
 117   # in order to also check tests and non-default crate features, use
 118   - cargo clippy --all-targets --all-features -- -D warnings
 119   - cargo test
 120   # etc.
 121 ```
 122
 123 If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
 124 In this case you can try to conditionally install Clippy from the Git repo.
 125
 126 ```yaml
 127 language: rust
 128 rust:
 129   - nightly
 130 before_script:
 131    - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
 132    # etc.
 133 ```
 134
 135 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
 136 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
 137 an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
 138 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
 139
 140 ## Configuration
 141
 142 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable =
 143 value` mapping eg.
 144
 145 ```toml
 146 blacklisted-names = ["toto", "tata", "titi"]
 147 cognitive-complexity-threshold = 30
 148 ```
 149
 150 See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which
 151 lints can be configured and the meaning of the variables.
 152
 153 To deactivate the “for further information visit *lint-link*” message you can
 154 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 155
 156 ### Allowing/denying lints
 157
 158 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 159
 160 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 161
 162 *   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
 163     `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
 164     lints prone to false positives.
 165
 166 *   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
 167
 168 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
 169
 170 Note: `allow` in this case means to "allow your code to have the lint without
 171 warning".  `deny` means "produce an error if your code has the lint".  `warn`
 172 means "produce a warning, but don't produce an error due to this lint".  An
 173 error causes clippy to exit with an error code, so is useful in scripts like
 174 CI/CD.
 175
 176 If you do not want to include your lint levels in your code, you can globally
 177 enable/disable lints by passing extra flags to Clippy during the run:
 178
 179 To allow `lint_name`, run
 180
 181 ```terminal
 182 cargo clippy -- -A clippy::lint_name
 183 ```
 184
 185 And to warn on `lint_name`, run
 186
 187 ```terminal
 188 cargo clippy -- -W clippy::lint_name
 189 ```
 190
 191 This also works with lint groups. For example you
 192 can run Clippy with warnings for all lints enabled:
 193 ```terminal
 194 cargo clippy -- -W clippy::pedantic
 195 ```
 196
 197 If you care only about a single lint, you can allow all others and then explicitly warn on
 198 the lint(s) you are interested in:
 199 ```terminal
 200 cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
 201 ```
 202 Note that if you've run clippy before, this may only take effect after you've modified a file or ran `cargo clean`.
 203
 204 ## Contributing
 205
 206 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).
 207
 208 ## License
 209
 210 Copyright 2014-2020 The Rust Project Developers
 211
 212 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 213 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
 214 <LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your
 215 option. Files in the project may not be
 216 copied, modified, or distributed except according to those terms.