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 # Clippy
   4
   5 [![Build Status](https://travis-ci.org/rust-lang/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang/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: MIT/Apache-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 290 lints included in this crate!](https://rust-lang.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::all` (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/rust-clippy/issues) if you have ideas!
  26
  27 Only the following of those categories are enabled by default:
  28
  29 * `clippy::style`
  30 * `clippy::correctness`
  31 * `clippy::complexity`
  32 * `clippy::perf`
  33
  34 Other categories need to be enabled in order for their lints to be executed.
  35
  36 Table of contents:
  37
  38 *   [Usage instructions](#usage)
  39 *   [Configuration](#configuration)
  40 *   [License](#license)
  41
  42 ## Usage
  43
  44 Since this is a tool for helping the developer of a library or application
  45 write better code, it is recommended not to include Clippy as a hard dependency.
  46 Options include using it as an optional dependency, as a cargo subcommand, or
  47 as an included feature during build. These options are detailed below.
  48
  49 ### As a cargo subcommand (`cargo clippy`)
  50
  51 One way to use Clippy is by installing Clippy through rustup as a cargo
  52 subcommand.
  53
  54 #### Step 1: Install rustup
  55
  56 You can install [rustup](http://rustup.rs/) on supported platforms. This will help
  57 us install Clippy and its dependencies.
  58
  59 If you already have rustup installed, update to ensure you have the latest
  60 rustup and compiler:
  61
  62 ```terminal
  63 rustup update
  64 ```
  65
  66 #### Step 2: Install Clippy
  67
  68 Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
  69
  70 ```terminal
  71 rustup component add clippy-preview
  72 ```
  73
  74 Now you can run Clippy by invoking `cargo clippy`.
  75
  76 If it says that it can't find the `clippy` subcommand, please run `rustup self update`
  77
  78 ### Running Clippy from the command line without installing it
  79
  80 To have cargo compile your crate with Clippy without Clippy installation
  81 in your code, you can use:
  82
  83 ```terminal
  84 cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
  85 ```
  86
  87 *[Note](https://github.com/rust-lang/rust-clippy/wiki#a-word-of-warning):*
  88 Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
  89
  90 ### Travis CI
  91
  92 You can add Clippy to Travis CI in the same way you use it locally:
  93
  94 ```yml
  95 language: rust
  96 rust:
  97   - stable
  98   - beta
  99 before_script:
 100   - rustup component add clippy-preview
 101 script:
 102   - cargo clippy
 103   # if you want the build job to fail when encountering warnings, use
 104   - cargo clippy -- -D warnings
 105   # in order to also check tests and none-default crate features, use
 106   - cargo clippy --all-targets --all-features -- -D warnings
 107   - cargo test
 108   # etc.
 109 ```
 110
 111 It might happen that clippy is not available for a certain nightly release.
 112 In this case you can try to conditionally install clippy from the git repo.
 113
 114 ```yaml
 115 language: rust
 116 rust:
 117   - nightly
 118 before_script:
 119    - rustup component add clippy-preview --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
 120    # etc
 121 ```
 122
 123 ## Configuration
 124
 125 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg.
 126
 127 ```toml
 128 blacklisted-names = ["toto", "tata", "titi"]
 129 cyclomatic-complexity-threshold = 30
 130 ```
 131
 132 See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which lints can be configured and the
 133 meaning of the variables.
 134
 135 To deactivate the “for further information visit *lint-link*” message you can
 136 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 137
 138 ### Allowing/denying lints
 139
 140 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 141
 142 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 143
 144 *   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
 145     `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
 146     lints prone to false positives.
 147
 148 *   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
 149
 150 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 151
 152 Note: `deny` produces errors instead of warnings.
 153
 154 Note: To use the new `clippy::lint_name` syntax, a recent compiler has to be used
 155 currently. If you want to compile your code with the stable toolchain you can use a `cfg_attr` to
 156 activate the `tool_lints` feature:
 157 ```rust
 158 #![cfg_attr(feature = "cargo-clippy", allow(clippy::lint_name))]
 159 ```
 160
 161 For this to work you have to use Clippy on the nightly toolchain: `cargo +nightly clippy`. If you
 162 want to use Clippy with the stable toolchain, you can stick to the old unscoped method to
 163 enable/disable Clippy lints until `tool_lints` are stable:
 164 ```rust
 165 #![cfg_attr(feature = "cargo-clippy", allow(clippy_lint))]
 166 ```
 167
 168 If you do not want to include your lint levels in your code, you can globally enable/disable lints by passing extra flags to clippy during the run: `cargo clippy -- -A lint_name` will run clippy with `lint_name` disabled and `cargo clippy -- -W lint_name` will run it with that enabled. On newer compilers you may need to use `clippy::lint_name` instead.
 169
 170 ## License
 171
 172 Copyright 2014-2018 The Rust Project Developers
 173
 174 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 175 http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 176 <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 177 option. All files in the project carrying such notice may not be
 178 copied, modified, or distributed except according to those terms.