A bunch of lints to catch common mistakes and improve your Rust code https://rust-lang.github.io/rust-clippy/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
bors 7ea7cd165a Auto merge of #5652 - rust-lang:flip1995-patch-1, r=yaahc 2 days ago
.cargo Deprecate util/dev in favor of cargo alias 4 months ago
.github Auto merge of #5652 - rust-lang:flip1995-patch-1, r=yaahc 2 days ago
clippy_dev Make the name of the crate available in cargo UI tests 4 days ago
clippy_dummy Fix markdown Files 3 months ago
clippy_lints Auto merge of #5631 - ThibsG:ExtendUselessConversion, r=matthiaskrgr 2 days ago
clippy_workspace_tests a few small cleanups 5 months ago
doc Add common lint tools doc 4 days ago
etc/relicense Fix markdown Files 3 months ago
mini-macro Stabilize fn-like proc macros in expression, pattern and statement positions 3 weeks ago
rustc_tools_util To make it easier for Linux distributions, ship the licenses text within 4 days ago
src Auto merge of #5631 - ThibsG:ExtendUselessConversion, r=matthiaskrgr 2 days ago
tests Auto merge of #5631 - ThibsG:ExtendUselessConversion, r=matthiaskrgr 2 days ago
util Remove util/dev script 1 month ago
.editorconfig Prefer 2 spaces as indent size over 4 on yaml 4 months ago
.gitattributes git attribute macros not allowed in submodules 2 months ago
.gitignore Small change to comment in .gitignore 3 months ago
.remarkrc Rename .remarkrc.json -> .remarkrc and fix file 3 months ago
CHANGELOG.md Auto merge of #5582 - vtmargaryan:match_wildcard_for_single_variants, r=flip1995 1 week ago
CODE_OF_CONDUCT.md Fix markdown Files 3 months ago
CONTRIBUTING.md Also fetch origin before merging master into the rustup branch 4 days ago
COPYRIGHT update license year to 2020 4 months ago
Cargo.toml deps: remove unused regex dependency from root crate 3 weeks ago
LICENSE-APACHE Add Copyright claim, where missing 3 months ago
LICENSE-MIT Add Copyright claim, where missing 3 months ago
README.md README: fix lit count line 1 month ago
build.rs clippy: bump rustc_tools util version to 0.2 1 year ago
rust-toolchain Add rust-toolchain file 1 year ago
rustfmt.toml Revert "Revert global fmt config and use `rustfmt::skip`" 10 months ago
setup-toolchain.sh Also install llvm-tools on toolchain setup 1 week ago
triagebot.toml Allow everyone to assign labels with rustbot 8 months ago

README.md

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 350 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 is on by default: all the categories below except for nursery, pedantic, and cargo)
  • clippy::correctness (code that is just outright wrong or very very useless, causes hard errors by default)
  • 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::pedantic (lints which are rather strict, off by default)
  • clippy::nursery (new lints that aren’t quite ready yet, off by default)
  • clippy::cargo (checks against the cargo manifest, off by default)

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.

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

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

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

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

If you are on nightly, 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.

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: deny produces errors instead of warnings.

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 clippy::lint_name will run Clippy with lint_name disabled and
cargo clippy -- -W clippy::lint_name will run it with that enabled. 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 reenable
the lint(s) you are interested in: cargo clippy -- -Aclippy::all -Wclippy::useless_format -Wclippy::...

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.