README.md

   1 # rust-clippy
   2
   3 [![Build Status](https://travis-ci.org/rust-lang-nursery/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rust-clippy)
   4 [![Windows build status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rust-clippy?svg=true)](https://ci.appveyor.com/project/rust-lang-nursery/rust-clippy)
   5 [![Current Version](http://meritbadge.herokuapp.com/clippy)](https://crates.io/crates/clippy)
   6 [![License: MPL-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 249 lints included in this crate!](https://rust-lang-nursery.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` (everything that has no false positives)
  15 * `clippy_pedantic` (everything)
  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_correctness`** (code that is just outright wrong or very very useless)
  20
  21 More to come, please [file an issue](https://github.com/rust-lang-nursery/rust-clippy/issues) if you have ideas!
  22
  23 Table of contents:
  24
  25 *   [Usage instructions](#usage)
  26 *   [Configuration](#configuration)
  27 *   [License](#license)
  28
  29 ## Usage
  30
  31 Since this is a tool for helping the developer of a library or application
  32 write better code, it is recommended not to include clippy as a hard dependency.
  33 Options include using it as an optional dependency, as a cargo subcommand, or
  34 as an included feature during build. All of these options are detailed below.
  35
  36 As a general rule clippy will only work with the *latest* Rust nightly for now.
  37
  38 To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/):
  39
  40 ```terminal
  41 rustup install nightly
  42 ```
  43
  44 ### As a cargo subcommand (`cargo clippy`)
  45
  46 One way to use clippy is by installing clippy through cargo as a cargo
  47 subcommand.
  48
  49 ```terminal
  50 cargo +nightly install clippy
  51 ```
  52
  53 (The `+nightly` is not necessary if your default `rustup` install is nightly)
  54
  55 Now you can run clippy by invoking `cargo +nightly clippy`.
  56
  57 To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
  58
  59 ```terminal
  60 rustup update nightly
  61 cargo +nightly install --force clippy
  62 ```
  63
  64 In case you are not using rustup, you need to set the environment flag
  65 `SYSROOT` during installation so clippy knows where to find `librustc` and
  66 similar crates.
  67
  68 ```terminal
  69 SYSROOT=/path/to/rustc/sysroot cargo install clippy
  70 ```
  71
  72 ### Optional dependency
  73
  74 In some cases you might want to include clippy in your project directly, as an
  75 optional dependency. To do this, just modify `Cargo.toml`:
  76
  77 ```toml
  78 [dependencies]
  79 clippy = { version = "*", optional = true }
  80 ```
  81
  82 And, in your `main.rs` or `lib.rs`, add these lines:
  83
  84 ```rust
  85 #![cfg_attr(feature="clippy", feature(plugin))]
  86 #![cfg_attr(feature="clippy", plugin(clippy))]
  87 ```
  88
  89 Then build by enabling the feature: `cargo +nightly build --features "clippy"`.
  90
  91 Instead of adding the `cfg_attr` attributes you can also run clippy on demand:
  92 `cargo rustc --features clippy -- -Z no-trans -Z extra-plugins=clippy`
  93 (the `-Z no trans`, while not necessary, will stop the compilation process after
  94 typechecking (and lints) have completed, which can significantly reduce the runtime).
  95
  96 Alternatively, to only run clippy when testing:
  97
  98 ```toml
  99 [dev-dependencies]
 100 clippy = { version = "*" }
 101 ```
 102
 103 and add to `main.rs` or  `lib.rs`:
 104
 105 ```
 106 #![cfg_attr(test, feature(plugin))]
 107 #![cfg_attr(test, plugin(clippy))]
 108 ```
 109
 110 ### Running clippy from the command line without installing it
 111
 112 To have cargo compile your crate with clippy without clippy installation and without needing `#![plugin(clippy)]`
 113 in your code, you can use:
 114
 115 ```terminal
 116 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
 117 ```
 118
 119 *[Note](https://github.com/rust-lang-nursery/rust-clippy/wiki#a-word-of-warning):*
 120 Be sure that clippy was compiled with the same version of rustc that cargo invokes here!
 121
 122 ### As a Compiler Plugin
 123
 124 *Note:* This is not a recommended installation method.
 125
 126 Since stable Rust is backwards compatible, you should be able to
 127 compile your stable programs with nightly Rust with clippy plugged in to
 128 circumvent this.
 129
 130 Add in your `Cargo.toml`:
 131
 132 ```toml
 133 [dependencies]
 134 clippy = "*"
 135 ```
 136
 137 You then need to add `#![feature(plugin)]` and `#![plugin(clippy)]` to the top
 138 of your crate entry point (`main.rs` or `lib.rs`).
 139
 140 Sample `main.rs`:
 141
 142 ```rust
 143 #![feature(plugin)]
 144
 145 #![plugin(clippy)]
 146
 147
 148 fn main(){
 149     let x = Some(1u8);
 150     match x {
 151         Some(y) => println!("{:?}", y),
 152         _ => ()
 153     }
 154 }
 155 ```
 156
 157 Produces this warning:
 158
 159 ```terminal
 160 src/main.rs:8:5: 11:6 warning: you seem to be trying to use match for destructuring a single type. Consider using `if let`, #[warn(single_match)] on by default
 161 src/main.rs:8     match x {
 162 src/main.rs:9         Some(y) => println!("{:?}", y),
 163 src/main.rs:10         _ => ()
 164 src/main.rs:11     }
 165 src/main.rs:8:5: 11:6 help: Try
 166 if let Some(y) = x { println!("{:?}", y) }
 167 ```
 168
 169 ## Configuration
 170
 171 Some lints can be configured in a TOML file named with `clippy.toml` or `.clippy.toml`. It contains basic `variable = value` mapping eg.
 172
 173 ```toml
 174 blacklisted-names = ["toto", "tata", "titi"]
 175 cyclomatic-complexity-threshold = 30
 176 ```
 177
 178 See the [list of lints](https://rust-lang-nursery.github.io/rust-clippy/master/index.html) for more information about which lints can be configured and the
 179 meaning of the variables.
 180
 181 You can also specify the path to the configuration file with:
 182
 183 ```rust
 184 #![plugin(clippy(conf_file="path/to/clippy's/configuration"))]
 185 ```
 186
 187 To deactivate the “for further information visit *lint-link*” message you can
 188 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 189
 190 ### Allowing/denying lints
 191
 192 You can add options  to `allow`/`warn`/`deny`:
 193
 194 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy)]`)
 195
 196 *   all lints using both the `clippy` and `clippy_pedantic` lint groups (`#![deny(clippy)]`,
 197     `#![deny(clippy_pedantic)]`). Note that `clippy_pedantic` contains some very aggressive
 198     lints prone to false positives.
 199
 200 *   only some lints (`#![deny(single_match, box_vec)]`, etc)
 201
 202 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 203
 204 Note: `deny` produces errors instead of warnings.
 205
 206 For convenience, `cargo clippy` automatically defines a `cargo-clippy`
 207 feature. This lets you set lint levels and compile with or without clippy
 208 transparently:
 209
 210 ```rust
 211 #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
 212 ```
 213
 214 ## Updating rustc
 215
 216 Sometimes, rustc moves forward without clippy catching up. Therefore updating
 217 rustc may leave clippy a non-functional state until we fix the resulting
 218 breakage.
 219
 220 You can use the [rust-update](rust-update) script to update rustc only if
 221 clippy would also update correctly.
 222
 223 ## License
 224
 225 Licensed under [MPL](https://www.mozilla.org/MPL/2.0/).
 226 If you're having issues with the license, let me know and I'll try to change it to something more permissive.