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