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/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 306 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 *   [License](#license)
  40
  41 ## Usage
  42
  43 Since this is a tool for helping the developer of a library or application
  44 write better code, it is recommended not to include Clippy as a hard dependency.
  45 Options include using it as an optional dependency, as a cargo subcommand, or
  46 as an included feature during build. These options are detailed below.
  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](http://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 ### Running Clippy from the command line without installing it
  83
  84 To have cargo compile your crate with Clippy without Clippy installation
  85 in your code, you can use:
  86
  87 ```terminal
  88 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  89 ```
  90
  91 *[Note](https://github.com/rust-lang/rust-clippy/wiki#a-word-of-warning):*
  92 Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
  93
  94 ### Travis CI
  95
  96 You can add Clippy to Travis CI in the same way you use it locally:
  97
  98 ```yml
  99 language: rust
 100 rust:
 101   - stable
 102   - beta
 103 before_script:
 104   - rustup component add clippy
 105 script:
 106   - cargo clippy
 107   # if you want the build job to fail when encountering warnings, use
 108   - cargo clippy -- -D warnings
 109   # in order to also check tests and non-default crate features, use
 110   - cargo clippy --all-targets --all-features -- -D warnings
 111   - cargo test
 112   # etc.
 113 ```
 114
 115 If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
 116 In this case you can try to conditionally install Clippy from the git repo.
 117
 118 ```yaml
 119 language: rust
 120 rust:
 121   - nightly
 122 before_script:
 123    - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
 124    # etc
 125 ```
 126
 127 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
 128 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
 129 an error for clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
 130 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
 131
 132 ## Configuration
 133
 134 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg.
 135
 136 ```toml
 137 blacklisted-names = ["toto", "tata", "titi"]
 138 cognitive-complexity-threshold = 30
 139 ```
 140
 141 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
 142 meaning of the variables.
 143
 144 To deactivate the “for further information visit *lint-link*” message you can
 145 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 146
 147 ### Allowing/denying lints
 148
 149 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 150
 151 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 152
 153 *   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
 154     `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
 155     lints prone to false positives.
 156
 157 *   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
 158
 159 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 160
 161 Note: `deny` produces errors instead of warnings.
 162
 163 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`
 164
 165 ## Contributing
 166
 167 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).
 168
 169 ## License
 170
 171 Copyright 2014-2019 The Rust Project Developers
 172
 173 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 174 [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
 175 <LICENSE-MIT or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)>, at your
 176 option. All files in the project carrying such notice may not be
 177 copied, modified, or distributed except according to those terms.