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