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 for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used very selectively, if at all.
  34
  35 Table of contents:
  36
  37 *   [Usage instructions](#usage)
  38 *   [Configuration](#configuration)
  39 *   [Contributing](#contributing)
  40 *   [License](#license)
  41
  42 ## Usage
  43
  44 Since this is a tool for helping the developer of a library or application
  45 write better code, it is recommended not to include Clippy as a hard dependency.
  46 Options include using it as an optional dependency, as a cargo subcommand, or
  47 as an included feature during build. These options are detailed below.
  48
  49 ### As a cargo subcommand (`cargo clippy`)
  50
  51 One way to use Clippy is by installing Clippy through rustup as a cargo
  52 subcommand.
  53
  54 #### Step 1: Install rustup
  55
  56 You can install [rustup](https://rustup.rs/) on supported platforms. This will help
  57 us install Clippy and its dependencies.
  58
  59 If you already have rustup installed, update to ensure you have the latest
  60 rustup and compiler:
  61
  62 ```terminal
  63 rustup update
  64 ```
  65
  66 #### Step 2: Install Clippy
  67
  68 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
  69
  70 ```terminal
  71 rustup component add clippy
  72 ```
  73 If it says that it can't find the `clippy` component, please run `rustup self update`.
  74
  75 #### Step 3: Run Clippy
  76
  77 Now you can run Clippy by invoking the following command:
  78
  79 ```terminal
  80 cargo clippy
  81 ```
  82
  83 #### Automatically applying Clippy suggestions
  84
  85 Some Clippy lint suggestions can be automatically applied by `cargo fix`.
  86 Note that this is still experimental and only supported on the nightly channel:
  87
  88 ```terminal
  89 cargo fix -Z unstable-options --clippy
  90 ```
  91
  92 ### Running Clippy from the command line without installing it
  93
  94 To have cargo compile your crate with Clippy without Clippy installation
  95 in your code, you can use:
  96
  97 ```terminal
  98 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  99 ```
 100
 101 *Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
 102
 103 ### Travis CI
 104
 105 You can add Clippy to Travis CI in the same way you use it locally:
 106
 107 ```yml
 108 language: rust
 109 rust:
 110   - stable
 111   - beta
 112 before_script:
 113   - rustup component add clippy
 114 script:
 115   - cargo clippy
 116   # if you want the build job to fail when encountering warnings, use
 117   - cargo clippy -- -D warnings
 118   # in order to also check tests and non-default crate features, use
 119   - cargo clippy --all-targets --all-features -- -D warnings
 120   - cargo test
 121   # etc.
 122 ```
 123
 124 If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
 125 In this case you can try to conditionally install Clippy from the Git repo.
 126
 127 ```yaml
 128 language: rust
 129 rust:
 130   - nightly
 131 before_script:
 132    - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
 133    # etc.
 134 ```
 135
 136 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
 137 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
 138 an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
 139 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
 140
 141 ## Configuration
 142
 143 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = 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 lints can be configured and the
 151 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: `deny` produces errors instead of warnings.
 171
 172 If you do not want to include your lint levels in your code, you can globally enable/disable lints by passing extra flags to Clippy during the run: `cargo clippy -- -A clippy::lint_name` will run Clippy with `lint_name` disabled and `cargo clippy -- -W clippy::lint_name` will run it with that enabled. This also works with lint groups. For example you can run Clippy with warnings for all lints enabled: `cargo clippy -- -W clippy::pedantic`
 173
 174 ## Contributing
 175
 176 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).
 177
 178 ## License
 179
 180 Copyright 2014-2019 The Rust Project Developers
 181
 182 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 183 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
 184 <LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your
 185 option. Files in the project may not be
 186 copied, modified, or distributed except according to those terms.