Go to file
Philipp Hansch cafef7b576
Merge pull request #3137 from matthiaskrgr/clippy_git_version
print git commit hash and commit date in version output
2018-09-06 18:21:14 +01:00
.github Add exec bit, add set -ex to ci test files 2018-05-16 18:55:21 +02:00
ci print git commit hash and commit date in version output 2018-09-06 14:45:12 +02:00
clippy_dev Pass by ref instead of value 2018-09-06 08:19:09 +02:00
clippy_lints print_with_newline / write_with_newline: don't warn about string with several `\n`s in them. 2018-09-06 12:59:34 +02:00
clippy_workspace_tests Fix logic that determines closest parent crate when invoked from a subdirectory. 2017-07-27 00:04:17 -07:00
mini-macro Remove implied rust_2018 feature 2018-08-19 19:14:47 -07:00
rustc_tools_util print git commit hash and commit date in version output 2018-09-06 14:45:12 +02:00
src print git commit hash and commit date in version output 2018-09-06 14:45:12 +02:00
tests print_with_newline / write_with_newline: don't warn about string with several `\n`s in them. 2018-09-06 12:59:34 +02:00
util update_lints rewrite: Add structure and --print-only 2018-09-03 22:18:51 +02:00
.editorconfig Add EditorConfig 2016-07-15 13:08:21 +02:00
.gitignore print git commit hash and commit date in version output 2018-09-06 14:45:12 +02:00
.remarkrc.json use .remarkrc.json for travis 2016-05-06 16:13:05 +02:00
.travis.yml Remove dependence of ci on github token 2018-09-03 09:20:15 +05:30
CHANGELOG.md s/wiki/lint list/ 2018-07-25 08:22:52 +02:00
CONTRIBUTING.md Adapt documentation to the tool_lints 2018-08-29 11:08:29 -07:00
Cargo.toml Merge pull request #3137 from matthiaskrgr/clippy_git_version 2018-09-06 18:21:14 +01:00
LICENSE Create LICENSE 2017-07-13 14:10:30 -07:00
PUBLISH.md Cleanup old min_version stuff 2018-09-03 22:27:35 +02:00
README.md Trigger rebuild for AppVeyor (and fix grammar) 2018-09-02 11:31:39 +02:00
appveyor.yml Remove dependence of ci on github token 2018-09-03 09:20:15 +05:30
build.rs print git commit hash and commit date in version output 2018-09-06 14:45:12 +02:00
pre_publish.sh Remove git diffing part 2018-08-30 07:33:53 +02:00
publish.files CHANGELOG is ordered after Cargo 2017-06-16 18:44:41 +02:00
rust-toolchain Add rust-toolchain file 2018-07-11 08:03:46 +02:00
rust-update Tiny typo in rust-update script 2018-06-07 17:47:11 +01:00
rustfmt.toml Remove removed rustfmt options 2018-05-09 15:31:52 +02:00

README.md

We are currently in the process of discussing Clippy 1.0 via the RFC process in https://github.com/rust-lang/rfcs/pull/2476 . The RFC's goal is to clarify policies around lint categorizations and the policy around which lints should be in the compiler and which lints should be in Clippy. Please leave your thoughts on the RFC PR.

Clippy

Build Status Windows Build status Current Version License: MPL-2.0

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

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

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 nightly toolchain

Rustup integration is still new, you will need a relatively new nightly (2018-07-15 or later).

To install Rust nightly with rustup:

rustup install nightly

Step 3: Install clippy

Once you have rustup and the nightly toolchain installed, run the following command:

rustup component add clippy-preview --toolchain=nightly

Now you can run Clippy by invoking cargo +nightly clippy. If nightly is your default toolchain in rustup, cargo clippy will work fine.

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!

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 allow/warn/deny:

  • 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.

Updating rustc

Sometimes, rustc moves forward without Clippy catching up. Therefore updating rustc may leave Clippy a non-functional state until we fix the resulting breakage.

You can use the rust-update script to update rustc only if Clippy would also update correctly.

License

Licensed under MPL. If you're having issues with the license, let me know and I'll try to change it to something more permissive.