Go to file
Philipp Krones 5f9af5f69c
Merge pull request #3242 from matthiaskrgr/rm_cargo_ed_feat
remove cargo edition 2018 feature gate.
2018-09-30 12:27:44 +02:00
.github Update ISSUE_TEMPLATE 2018-09-13 18:31:39 +02:00
ci Make travis check lint list 2018-09-19 07:05:36 +02:00
clippy_dev remove cargo edition 2018 feature gate. 2018-09-30 11:12:24 +02:00
clippy_lints remove cargo edition 2018 feature gate. 2018-09-30 11:12:24 +02:00
clippy_workspace_tests
mini-macro
rustc_tools_util remove cargo edition 2018 feature gate. 2018-09-30 11:12:24 +02:00
src Reintroduce extern crate for non-Cargo dependencies. 2018-09-15 11:10:51 +03:00
tests Merge branch 'master' into unnecessary_filter_map 2018-09-30 06:39:56 +02:00
util Fix update_lints.py for dir modules 2018-09-30 06:25:23 +02:00
.editorconfig
.gitignore consistently gitignore all Cargo.lock files 2018-09-27 12:34:16 +02:00
.remarkrc.json
.travis.yml Merge pull request #3241 from phansch/remove_clippy_service 2018-09-30 11:12:49 +01: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
Cargo.toml remove cargo edition 2018 feature gate. 2018-09-30 11:12:24 +02:00
CHANGELOG.md Implement unnecesary_filter_map lint 2018-09-26 06:52:36 +02:00
CONTRIBUTING.md Mention rustup component history 2018-09-20 07:10:23 +02:00
LICENSE
pre_publish.sh
publish.files
PUBLISH.md Cleanup old min_version stuff 2018-09-03 22:27:35 +02:00
README.md Implement unnecesary_filter_map lint 2018-09-26 06:52:36 +02:00
rust-toolchain
rustfmt.toml

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 279 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 Clippy

Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:

rustup component add clippy-preview

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

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, #![feature(tool_lints)] has to be activated 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", feature(tool_lints))]
#![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))]

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.