README.md

   1 We are currently in the process of discussing Clippy 1.0 via the RFC process in https://github.com/rust-lang/rfcs/pull/2476 . The RFC's goal is to clarify policies around lint categorizations and the policy around which lints should be in the compiler and which lints should be in clippy. Please leave your thoughts on the RFC PR.
   2
   3 # rust-clippy
   4
   5 [![Build Status](https://travis-ci.org/rust-lang-nursery/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rust-clippy)
   6 [![Windows Build status](https://ci.appveyor.com/api/projects/status/id677xpw1dguo7iw?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/rust-clippy)
   7 [![Current Version](https://meritbadge.herokuapp.com/clippy)](https://crates.io/crates/clippy)
   8 [![License: MPL-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
   9
  10 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
  11
  12 [There are 270 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
  13
  14 We have a bunch of lint categories to allow you to choose how much clippy is supposed to ~~annoy~~ help you:
  15
  16 * `clippy` (everything that has no false positives)
  17 * `clippy_pedantic` (everything)
  18 * `clippy_nursery` (new lints that aren't quite ready yet)
  19 * `clippy_style` (code that should be written in a more idiomatic way)
  20 * `clippy_complexity` (code that does something simple but in a complex way)
  21 * `clippy_perf` (code that can be written in a faster way)
  22 * `clippy_cargo` (checks against the cargo manifest)
  23 * **`clippy_correctness`** (code that is just outright wrong or very very useless)
  24
  25 More to come, please [file an issue](https://github.com/rust-lang-nursery/rust-clippy/issues) if you have ideas!
  26
  27 Table of contents:
  28
  29 *   [Usage instructions](#usage)
  30 *   [Configuration](#configuration)
  31 *   [License](#license)
  32
  33 ## Usage
  34
  35 Since this is a tool for helping the developer of a library or application
  36 write better code, it is recommended not to include clippy as a hard dependency.
  37 Options include using it as an optional dependency, as a cargo subcommand, or
  38 as an included feature during build. All of these options are detailed below.
  39
  40 As a general rule clippy will only work with the *latest* Rust nightly for now.
  41
  42 To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/):
  43
  44 ```terminal
  45 rustup install nightly
  46 ```
  47
  48 ### As a cargo subcommand (`cargo clippy`)
  49
  50 One way to use clippy is by installing clippy through cargo as a cargo
  51 subcommand.
  52
  53 ```terminal
  54 cargo +nightly install clippy
  55 ```
  56
  57 (The `+nightly` is not necessary if your default `rustup` install is nightly)
  58
  59 Now you can run clippy by invoking `cargo +nightly clippy`.
  60
  61 To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
  62
  63 ```terminal
  64 rustup update nightly
  65 cargo +nightly install --force clippy
  66 ```
  67
  68 In case you are not using rustup, you need to set the environment flag
  69 `SYSROOT` during installation so clippy knows where to find `librustc` and
  70 similar crates.
  71
  72 ```terminal
  73 SYSROOT=/path/to/rustc/sysroot cargo install clippy
  74 ```
  75
  76 ### Running clippy from the command line without installing it
  77
  78 To have cargo compile your crate with clippy without clippy installation
  79 in your code, you can use:
  80
  81 ```terminal
  82 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  83 ```
  84
  85 *[Note](https://github.com/rust-lang-nursery/rust-clippy/wiki#a-word-of-warning):*
  86 Be sure that clippy was compiled with the same version of rustc that cargo invokes here!
  87
  88 ## Configuration
  89
  90 Some lints can be configured in a TOML file named with `clippy.toml` or `.clippy.toml`. It contains basic `variable = value` mapping eg.
  91
  92 ```toml
  93 blacklisted-names = ["toto", "tata", "titi"]
  94 cyclomatic-complexity-threshold = 30
  95 ```
  96
  97 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
  98 meaning of the variables.
  99
 100 To deactivate the “for further information visit *lint-link*” message you can
 101 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 102
 103 ### Allowing/denying lints
 104
 105 You can add options  to `allow`/`warn`/`deny`:
 106
 107 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy)]`)
 108
 109 *   all lints using both the `clippy` and `clippy_pedantic` lint groups (`#![deny(clippy)]`,
 110     `#![deny(clippy_pedantic)]`). Note that `clippy_pedantic` contains some very aggressive
 111     lints prone to false positives.
 112
 113 *   only some lints (`#![deny(single_match, box_vec)]`, etc)
 114
 115 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 116
 117 Note: `deny` produces errors instead of warnings.
 118
 119 For convenience, `cargo clippy` automatically defines a `cargo-clippy`
 120 feature. This lets you set lint levels and compile with or without clippy
 121 transparently:
 122
 123 ```rust
 124 #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
 125 ```
 126
 127 ## Updating rustc
 128
 129 Sometimes, rustc moves forward without clippy catching up. Therefore updating
 130 rustc may leave clippy a non-functional state until we fix the resulting
 131 breakage.
 132
 133 You can use the [rust-update](rust-update) script to update rustc only if
 134 clippy would also update correctly.
 135
 136 ## License
 137
 138 Licensed under [MPL](https://www.mozilla.org/MPL/2.0/).
 139 If you're having issues with the license, let me know and I'll try to change it to something more permissive.