A collection of lints to catch common mistakes and improve your Rust code.
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::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!
Only the following of those categories are enabled by default:
Other categories need to be enabled in order for their lints to be executed.
Table of contents:
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 (
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:
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
Now you can run Clippy by invoking
If it says that it can't find the
clippy subcommand, please run
rustup self update
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!
You can add Clippy to Travis CI in the same way you use it locally:
language: rust rust: - stable - beta before_script: - rustup component add clippy 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.
It might happen that clippy is not available for a certain nightly release. In this case you can try to conditionally install clippy from the git repo.
language: rust rust: - nightly before_script: - rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy # etc
Some lints can be configured in a TOML file named
.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
CLIPPY_DISABLE_DOCS_LINKS environment variable.
You can add options to your code to
deny Clippy lints:
the whole set of
Warnlints using the
clippylint group (
all lints using both the
clippy::pedanticlint groups (
#![deny(clippy::pedantic)]). Note that
clippy::pedanticcontains some very aggressive lints prone to false positives.
only some lints (
#![deny(clippy::single_match, clippy::box_vec)], etc)
denycan be limited to a single function or module using
deny produces errors instead of warnings.
Note: To use the new
clippy::lint_name syntax, a recent compiler has to be used
currently. If you want to compile your code with the stable toolchain you can use a
#![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))]
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
Copyright 2014-2018 The Rust Project Developers
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option. All files in the project carrying such notice may not be copied, modified, or distributed except according to those terms.