rust-lang/rust-clippy


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

https://rust-lang.github.io/rust-clippy/

License: Other

Language: Rust


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.

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

Contributing

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

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.

Project Statistics

Sourcerank 17
Repository Size 12.5 MB
Stars 2,865
Forks 393
Watchers 68
Open issues 788
Dependencies 24
Contributors 273
Tags 147
Created
Last updated
Last pushed

Top Contributors See all

Oliver S̶c̶h̶n̶e̶i̶d̶e̶r Scherer Martin Carton Manish Goregaokar llogiq Philipp Hansch flip1995 Georg Brandl mikerite Matthias Krüger sinkuu Devon Hollowood bors Luis de Bethencourt bors[bot] Matthias Krüger Josh Mcguigan Florian Hartwig Mateusz Mikuła Taylor Cramer Seiichi Uchida

Packages Referencing this Repo

rustc_tools_util
small helper to generate version information for git packages
Latest release 0.1.1 - Updated - 2.87K stars
clippy_lints
A bunch of helpful lints to avoid common pitfalls in Rust
Latest release 0.0.212 - Updated - 2.87K stars
clippy
A bunch of helpful lints to avoid common pitfalls in Rust.
Latest release 0.0.302 - Updated - 2.87K stars
cccp
The Clippy Code Correctness Project
Latest release 0.1.0 - Published - 2.87K stars
clippy-mini-macro-test
A macro to test clippy's procedural macro checks
Latest release 0.2.0 - Updated - 2.87K stars

Recent Tags See all

v0.0.212 July 10, 2018
list July 09, 2018
v0.0.211 June 29, 2018
v0.0.210 June 25, 2018
v0.0.209 June 19, 2018
v0.0.209 June 19, 2018
v0.0.208 June 18, 2018
v0.0.207 June 10, 2018
v0.0.206 May 29, 2018
v0.0.205 May 26, 2018
v0.0.205 May 26, 2018
v0.0.204 May 23, 2018
v0.0.203 May 20, 2018
v0.0.202 May 19, 2018
v0.0.201 May 17, 2018

Something wrong with this page? Make a suggestion

Last synced: 2019-01-03 02:17:34 UTC

Login to resync this repository