README.md

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