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