Empowering everyone to build reliable and efficient software.
Go to file
2021-02-01 16:49:53 +01:00
.cargo rename cargo dev crater to cargo dev lintcheck 2021-01-23 02:18:11 +01:00
.github Auto merge of #6495 - matthiaskrgr:FN_FP_issue_templates, r=flip1995 2020-12-27 12:53:04 +00:00
clippy_dev clippy_dev: Pass stderr to CommandFailed 2021-01-31 11:21:33 +01:00
clippy_dummy Fix markdown Files 2020-02-12 09:34:25 +01:00
clippy_lints Rename lint 2021-02-01 16:49:53 +01:00
clippy_workspace_tests Add --no-deps command-line argument 2020-11-27 17:41:50 +01:00
doc Added documentation for adding a configuration to lints 2021-01-24 21:16:41 +01:00
etc/relicense Fix markdown Files 2020-02-12 09:34:25 +01:00
lintcheck-logs lintcheck: fix paths in the logs 2021-01-23 02:18:11 +01:00
mini-macro Stabilize fn-like proc macros in expression, pattern and statement positions 2020-05-03 19:24:41 +03:00
rustc_tools_util To make it easier for Linux distributions, ship the licenses text within 2020-05-25 23:06:08 +02:00
src Change env var used for testing Clippy 2021-01-07 12:38:10 +01:00
tests Rename lint 2021-02-01 16:49:53 +01:00
util Fix some website syntax highlighting 2021-01-26 17:38:52 -06:00
.editorconfig Prefer 2 spaces as indent size over 4 on yaml 2020-01-10 04:34:56 +09:00
.gitattributes git attribute macros not allowed in submodules 2020-03-29 06:58:37 -07:00
.gitignore Small change to comment in .gitignore 2020-02-12 09:34:26 +01:00
.remarkrc Rename .remarkrc.json -> .remarkrc and fix file 2020-02-12 09:34:25 +01:00
build.rs clippy: bump rustc_tools util version to 0.2 2019-05-23 17:40:54 +02:00
Cargo.toml Bump Clippy version to 0.1.51 2021-01-02 16:26:10 +01:00
CHANGELOG.md Rename lint 2021-02-01 16:49:53 +01:00
CODE_OF_CONDUCT.md Fix markdown Files 2020-02-12 09:34:25 +01:00
CONTRIBUTING.md Fix formulations in label descriptions 2021-01-15 11:30:58 +01:00
COPYRIGHT update license year to 2020 2020-01-15 15:00:54 +08:00
LICENSE-APACHE Add Copyright claim, where missing 2020-02-20 12:06:44 +01:00
LICENSE-MIT Add Copyright claim, where missing 2020-02-20 12:06:44 +01:00
README.md Revert "Pass Clippy args also trough RUSTFLAGS" 2020-12-22 19:17:59 +01:00
rust-toolchain Bump nightly version -> 2021-01-30 2021-01-30 15:52:02 +01:00
rustfmt.toml Revert "Revert global fmt config and use rustfmt::skip" 2019-07-23 02:57:49 +08:00
triagebot.toml Renamed the good first issue label for rustbot 2020-12-18 21:18:15 +00:00

Clippy

Clippy Test License: MIT OR Apache-2.0

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

There are over 400 lints included in this crate!

Lints are divided into categories, each with a default lint level. You can choose how much Clippy is supposed to annoy help you by changing the lint level by category.

Category Description Default level
clippy::all all lints that are on by default (correctness, style, complexity, perf) warn/deny
clippy::correctness code that is outright wrong or very useless deny
clippy::style code that should be written in a more idiomatic way warn
clippy::complexity code that does something simple but in a complex way warn
clippy::perf code that can be written to run faster warn
clippy::pedantic lints which are rather strict or might have false positives allow
clippy::nursery new lints that are still under development allow
clippy::cargo lints for the cargo manifest allow

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

The lint list also contains "restriction lints", which are for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used very selectively, if at all.

Table of contents:

Usage

Below are instructions on how to use Clippy as a subcommand, compiled from source or in Travis CI.

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

If it says that it can't find the clippy component, please run rustup self update.

Step 3: Run Clippy

Now you can run Clippy by invoking the following command:

cargo clippy

Automatically applying Clippy suggestions

Clippy can automatically apply some lint suggestions. Note that this is still experimental and only supported on the nightly channel:

cargo clippy --fix -Z unstable-options

Workspaces

All the usual workspace options should work with Clippy. For example the following command will run Clippy on the example crate:

cargo clippy -p example

As with cargo check, this includes dependencies that are members of the workspace, like path dependencies. If you want to run Clippy only on the given crate, use the --no-deps option like this:

cargo clippy -p example -- --no-deps 

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 non-default crate features, use
  - cargo clippy --all-targets --all-features -- -D warnings
  - cargo test
  # etc.

Note that adding -D warnings will cause your build to fail if any warnings are found in your code. That includes warnings found by rustc (e.g. dead_code, etc.). If you want to avoid this and only cause an error for Clippy warnings, use #![deny(clippy::all)] in your code or -D clippy::all on the command line. (You can swap clippy::all with the specific lint category you are targeting.)

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"]
cognitive-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: allow means to suppress the lint for your code. With warn the lint will only emit a warning, while with deny the lint will emit an error, when triggering for your code. An error causes clippy to exit with an error code, so is useful in scripts like CI/CD.

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:

To allow lint_name, run

cargo clippy -- -A clippy::lint_name

And to warn on lint_name, run

cargo clippy -- -W clippy::lint_name

This also works with lint groups. For example you can run Clippy with warnings for all lints enabled:

cargo clippy -- -W clippy::pedantic

If you care only about a single lint, you can allow all others and then explicitly warn on the lint(s) you are interested in:

cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...

Note that if you've run clippy before, this may only take effect after you've modified a file or ran cargo clean.

Specifying the minimum supported Rust version

Projects that intend to support old versions of Rust can disable lints pertaining to newer features by specifying the minimum supported Rust version (MSRV) in the clippy configuration file.

msrv = "1.30.0"

The MSRV can also be specified as an inner attribute, like below.

#![feature(custom_inner_attributes)]
#![clippy::msrv = "1.30.0"]

fn main() {
  ...
}

You can also omit the patch version when specifying the MSRV, so msrv = 1.30 is equivalent to msrv = 1.30.0.

Note: custom_inner_attributes is an unstable feature so it has to be enabled explicitly.

Lints that recognize this configuration option can be found here

Contributing

If you want to contribute to Clippy, you can find more information in CONTRIBUTING.md.

License

Copyright 2014-2020 The Rust Project Developers

Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your option. Files in the project may not be copied, modified, or distributed except according to those terms.