A bunch of lints to catch common mistakes and improve your Rust code
Clone or download
bors Auto merge of #3511 - phansch:remove_allow_doc_markdown, r=phansch
Remove allow(doc_markdown) in excessive_precision.rs

Closes #3299
Latest commit 0fd7fe9 Dec 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add license header to other files Oct 6, 2018
ci travis: base-tests: share CARGO_TARGET_DIR between check runs of subc… Dec 9, 2018
clippy_dev Run rustfmt on clippy_dev Nov 27, 2018
clippy_dummy rust-lang-nursery/rust-clippy => rust-lang/rust-clippy Nov 22, 2018
clippy_lints Auto merge of #3511 - phansch:remove_allow_doc_markdown, r=phansch Dec 10, 2018
clippy_workspace_tests Add license header to Rust files Oct 6, 2018
etc/relicense Fix some nursery links Dec 2, 2018
mini-macro rust-lang-nursery/rust-clippy => rust-lang/rust-clippy Nov 22, 2018
rustc_tools_util Run rustfmt on rustc_tools_util Nov 27, 2018
src Don't try to determine sysroot. rustc_driver will use default value. Dec 6, 2018
tests Auto merge of #3518 - sinkuu:redundant_clone_tw, r=phansch Dec 10, 2018
util rust-lang-nursery/rust-clippy => rust-lang/rust-clippy Nov 22, 2018
.editorconfig Add EditorConfig Jul 15, 2016
.gitattributes Enforce LF lineendings for everything Dec 2, 2018
.gitignore consistently gitignore all Cargo.lock files Sep 27, 2018
.remarkrc.json use .remarkrc.json for travis May 6, 2016
.travis.yml Add `fast_finish` to travis matrix Dec 9, 2018
CHANGELOG.md Renamed to `implicit_return`. Dec 5, 2018
CODE_OF_CONDUCT.md Add missing code of conduct file Nov 1, 2018
CONTRIBUTING.md Document bors/homu Dec 10, 2018
COPYRIGHT Add license to README Oct 7, 2018
Cargo.toml rust-lang-nursery/rust-clippy => rust-lang/rust-clippy Nov 22, 2018
LICENSE-APACHE Relicense clippy Oct 6, 2018
LICENSE-MIT Relicense clippy Oct 6, 2018
PUBLISH.md Cleanup old min_version stuff Sep 3, 2018
README.md Remove -preview suffix from README Dec 6, 2018
appveyor.yml ci: when installing rust-toolchain-installer-master, install it in de… Oct 31, 2018
bors.toml Setup bors Oct 22, 2018
build.rs Run rustfmt on build.rs Nov 27, 2018
pre_publish.sh Add license header to other files Oct 6, 2018
publish.files CHANGELOG is ordered after Cargo Jun 16, 2017
rust-toolchain Add rust-toolchain file Jul 11, 2018
rustfmt.toml Error on line overflow Nov 27, 2018

README.md

Clippy

Build Status Windows Build status Current Version License: MIT/Apache-2.0

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

There are 290 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!

Only the following of those categories are enabled by default:

  • clippy::style
  • clippy::correctness
  • clippy::complexity
  • clippy::perf

Other categories need to be enabled in order for their lints to be executed.

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

Now you can run Clippy by invoking cargo clippy.

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!

Travis CI

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

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, 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 to activate the tool_lints feature:

#![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 clippy::lint_name instead.

License

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.