A bunch of lints to catch common mistakes and improve your Rust code
Clone or download
Latest commit 125907a Sep 17, 2018
Permalink
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE Sep 13, 2018
ci Also run internal lints on the code base Sep 11, 2018
clippy_dev Change Hash{Map, Set} to FxHash{Map, Set} Sep 11, 2018
clippy_lints Fix c_void path Sep 17, 2018
clippy_workspace_tests Fix logic that determines closest parent crate when invoked from a su… Jul 27, 2017
mini-macro Remove implied rust_2018 feature Aug 20, 2018
rustc_tools_util Revert "the cargo feature: edition 2018 is stabilized in current nigh… Sep 15, 2018
src Reintroduce `extern crate` for non-Cargo dependencies. Sep 15, 2018
tests Reintroduce `extern crate` for non-Cargo dependencies, in tests. Sep 15, 2018
util update_lints rewrite: Add structure and --print-only Sep 3, 2018
.editorconfig Add EditorConfig Jul 15, 2016
.gitignore print git commit hash and commit date in version output Sep 6, 2018
.remarkrc.json use .remarkrc.json for travis May 6, 2016
.travis.yml Remove dependence of ci on github token Sep 3, 2018
CHANGELOG.md Add lint for misstyped literal casting Sep 5, 2018
CONTRIBUTING.md Adapt documentation to the tool_lints Aug 29, 2018
Cargo.toml Revert "the cargo feature: edition 2018 is stabilized in current nigh… Sep 15, 2018
LICENSE Create LICENSE Jul 13, 2017
PUBLISH.md Cleanup old min_version stuff Sep 3, 2018
README.md readme: show how to make the travis job fail when using clippy Sep 14, 2018
appveyor.yml Remove dependence of ci on github token Sep 3, 2018
build.rs print git commit hash and commit date in version output Sep 6, 2018
pre_publish.sh Remove git diffing part Aug 30, 2018
publish.files CHANGELOG is ordered after Cargo Jun 16, 2017
rust-toolchain Add rust-toolchain file Jul 11, 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 275 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::all (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 Clippy

Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:

rustup component add clippy-preview

Now you can run Clippy by invoking cargo clippy.

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!

Travis CI

You can add Clippy to Travis CI in the same way you use it locally:

- rust: stable
- rust: beta
  before_script:
    - rustup component add clippy-preview
  script:
    - cargo clippy
# if you want the build job to fail when encountering warnings, use
    - cargo clippy -- -D warnings
# in order to also check tests and none-default crate features, use
    - cargo clippy --all-targets --all-features -- -D warnings
    - cargo test
    # etc.

Configuration

Some lints can be configured in a TOML file named clippy.toml or .clippy.toml. It contains a 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 your code to allow/warn/deny Clippy lints:

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

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

  • only some lints (#![deny(clippy::single_match, clippy::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.

Note: To use the new clippy::lint_name syntax, #![feature(tool_lints)] has to be activated currently. If you want to compile your code with the stable toolchain you can use a cfg_attr to activate the tool_lints feature:

#![cfg_attr(feature = "cargo-clippy", feature(tool_lints))]
#![cfg_attr(feature = "cargo-clippy", allow(clippy::lint_name))]

For this to work you have to use Clippy on the nightly toolchain: cargo +nightly clippy. If you want to use Clippy with the stable toolchain, you can stick to the old unscoped method to enable/disable Clippy lints until tool_lints are stable:

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

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.