A bunch of lints to catch common mistakes and improve your Rust code
Rust Other
Clone or download
Permalink
Failed to load latest commit information.
.github Add exec bit, add set -ex to ci test files May 16, 2018
ci integration tests: add more clippy warnings for greater coverage Jul 29, 2018
clippy_lints Rustup to rustc 1.30.0-nightly (23f09bbed 2018-08-14) Aug 14, 2018
clippy_workspace_tests Fix logic that determines closest parent crate when invoked from a su… Jul 27, 2017
mini-macro Update mini-macro post proc macro stabilization Jul 16, 2018
src Rustup Jul 23, 2018
tests Merge pull request #3026 from dwijnand/fxhash Aug 14, 2018
util update_lints.py: port another print to print() for python3 compatibil… Aug 12, 2018
.editorconfig Add EditorConfig Jul 15, 2016
.gitignore Patterns, locals and matches for author lint May 11, 2018
.remarkrc.json use .remarkrc.json for travis May 6, 2016
.travis.yml Remove duplication of the cargo and rls repos from travis Jul 19, 2018
CHANGELOG.md s/wiki/lint list/ Jul 25, 2018
CONTRIBUTING.md CONTRIBUTING: mention discord channel. Jul 29, 2018
Cargo.toml Switch strategies for how rustc's workspace is unioned Aug 2, 2018
LICENSE Create LICENSE Jul 13, 2017
PUBLISH.md Add rust-toolchain file Jul 11, 2018
README.md some readme clarifications Jul 16, 2018
appveyor.yml Don't run cargo clippy on appveyor Jan 19, 2018
build.rs Consistently call it "Clippy", not clippy or rust-clippy Jul 5, 2018
min_version.txt Bump the version Jun 29, 2018
pre_publish.sh Sort entries in pre-publish script May 19, 2017
publish.files CHANGELOG is ordered after Cargo Jun 16, 2017
rust-toolchain Add rust-toolchain file Jul 11, 2018
rust-update Tiny typo in rust-update script Jun 7, 2018
rustfmt.toml Remove removed rustfmt options May 9, 2018

README.md

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.

Clippy

Build Status Windows Build status Current Version License: MPL-2.0

A collection of lints to catch common mistakes and improve your Rust code.

There are 273 lints included in this crate!

We have a bunch of lint categories to allow you to choose how much Clippy is supposed to annoy help you:

  • clippy (everything that has no false positives)
  • clippy_pedantic (everything)
  • clippy_nursery (new lints that aren't quite ready yet)
  • clippy_style (code that should be written in a more idiomatic way)
  • clippy_complexity (code that does something simple but in a complex way)
  • clippy_perf (code that can be written in a faster way)
  • clippy_cargo (checks against the cargo manifest)
  • clippy_correctness (code that is just outright wrong or very very useless)

More to come, please file an issue if you have ideas!

Table of contents:

Usage

Since this is a tool for helping the developer of a library or application write better code, it is recommended not to include Clippy as a hard dependency. Options include using it as an optional dependency, as a cargo subcommand, or as an included feature during build. These options are detailed below.

As a cargo subcommand (cargo clippy)

One way to use Clippy is by installing Clippy through rustup as a cargo subcommand.

Step 1: Install rustup

You can install rustup on supported platforms. This will help us install clippy and its dependencies.

If you already have rustup installed, update to ensure you have the latest rustup and compiler:

rustup update

Step 2: Install nightly toolchain

Rustup integration is still new, you will need a relatively new nightly (2018-07-15 or later).

To install Rust nightly with rustup:

rustup install nightly

Step 3: Install clippy

Once you have rustup and the nightly toolchain installed, run the following command:

rustup component add clippy-preview --toolchain=nightly

Now you can run Clippy by invoking cargo +nightly clippy. If nightly is your default toolchain in rustup, cargo clippy will work fine.

Running Clippy from the command line without installing it

To have cargo compile your crate with Clippy without Clippy installation in your code, you can use:

cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml

Note: Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!

Configuration

Some lints can be configured in a TOML file named with clippy.toml or .clippy.toml. It contains basic variable = value mapping eg.

blacklisted-names = ["toto", "tata", "titi"]
cyclomatic-complexity-threshold = 30

See the list of lints for more information about which lints can be configured and the meaning of the variables.

To deactivate the “for further information visit lint-link” message you can define the CLIPPY_DISABLE_DOCS_LINKS environment variable.

Allowing/denying lints

You can add options to allow/warn/deny:

  • the whole set of Warn lints using the clippy lint group (#![deny(clippy)])

  • all lints using both the clippy and clippy_pedantic lint groups (#![deny(clippy)], #![deny(clippy_pedantic)]). Note that clippy_pedantic contains some very aggressive lints prone to false positives.

  • only some lints (#![deny(single_match, box_vec)], etc)

  • allow/warn/deny can be limited to a single function or module using #[allow(...)], etc

Note: deny produces errors instead of warnings.

For convenience, cargo clippy automatically defines a cargo-clippy feature. This lets you set lint levels and compile with or without Clippy transparently:

#[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]

Updating rustc

Sometimes, rustc moves forward without Clippy catching up. Therefore updating rustc may leave Clippy a non-functional state until we fix the resulting breakage.

You can use the rust-update script to update rustc only if Clippy would also update correctly.

License

Licensed under MPL. If you're having issues with the license, let me know and I'll try to change it to something more permissive.