README.md

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