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 [![Current Version](https://meritbadge.herokuapp.com/clippy)](https://crates.io/crates/clippy)
   6 [![License: MIT/Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
   7
   8 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
   9
  10 [There are 301 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
  11
  12 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
  13
  14 * `clippy::all` (everything that is on by default: all the categories below except for `nursery`, `pedantic`, and `cargo`)
  15 * **`clippy::correctness`** (code that is just outright wrong or very very useless, causes hard errors by default)
  16 * `clippy::style` (code that should be written in a more idiomatic way)
  17 * `clippy::complexity` (code that does something simple but in a complex way)
  18 * `clippy::perf` (code that can be written in a faster way)
  19 * `clippy::pedantic` (lints which are rather strict, off by default)
  20 * `clippy::nursery` (new lints that aren't quite ready yet, off by default)
  21 * `clippy::cargo` (checks against the cargo manifest, off by default)
  22
  23 More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
  24
  25 Only the following of those categories are enabled by default:
  26
  27 * `clippy::style`
  28 * `clippy::correctness`
  29 * `clippy::complexity`
  30 * `clippy::perf`
  31
  32 Other categories need to be enabled in order for their lints to be executed.
  33
  34 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.
  35
  36 Table of contents:
  37
  38 *   [Usage instructions](#usage)
  39 *   [Configuration](#configuration)
  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](http://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 ### Running Clippy from the command line without installing it
  84
  85 To have cargo compile your crate with Clippy without Clippy installation
  86 in your code, you can use:
  87
  88 ```terminal
  89 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  90 ```
  91
  92 *[Note](https://github.com/rust-lang/rust-clippy/wiki#a-word-of-warning):*
  93 Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
  94
  95 ### Travis CI
  96
  97 You can add Clippy to Travis CI in the same way you use it locally:
  98
  99 ```yml
 100 language: rust
 101 rust:
 102   - stable
 103   - beta
 104 before_script:
 105   - rustup component add clippy
 106 script:
 107   - cargo clippy
 108   # if you want the build job to fail when encountering warnings, use
 109   - cargo clippy -- -D warnings
 110   # in order to also check tests and non-default crate features, use
 111   - cargo clippy --all-targets --all-features -- -D warnings
 112   - cargo test
 113   # etc.
 114 ```
 115
 116 If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
 117 In this case you can try to conditionally install Clippy from the git repo.
 118
 119 ```yaml
 120 language: rust
 121 rust:
 122   - nightly
 123 before_script:
 124    - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
 125    # etc
 126 ```
 127
 128 Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.
 129 That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause
 130 an error for clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command
 131 line. (You can swap `clippy::all` with the specific lint category you are targeting.)
 132
 133 ## Configuration
 134
 135 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg.
 136
 137 ```toml
 138 blacklisted-names = ["toto", "tata", "titi"]
 139 cognitive-complexity-threshold = 30
 140 ```
 141
 142 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
 143 meaning of the variables.
 144
 145 To deactivate the “for further information visit *lint-link*” message you can
 146 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 147
 148 ### Allowing/denying lints
 149
 150 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 151
 152 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 153
 154 *   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
 155     `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
 156     lints prone to false positives.
 157
 158 *   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
 159
 160 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 161
 162 Note: `deny` produces errors instead of warnings.
 163
 164 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`
 165
 166 ## Contributing
 167
 168 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).
 169
 170 ## License
 171
 172 Copyright 2014-2019 The Rust Project Developers
 173
 174 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 175 http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 176 <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 177 option. All files in the project carrying such notice may not be
 178 copied, modified, or distributed except according to those terms.