Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-26 06:30:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

Rearrange README.md.

Browse source 
This suggests `cargo clippy` first, which is probably the best method at this point. It also describes how to enable clippy only when testing.
This commit is contained in:
Clar Charr 2017-12-27 11:06:40 -05:00
parent f0d0fc69de
commit 8abf9647ce
1 changed files with 32 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -26,18 +26,35 @@ as an included feature during build. All of these options are detailed below.
As a general rule clippy will only work with the *latest* Rust nightly for now. As a general rule clippy will only work with the *latest* Rust nightly for now.
### As a cargo subcommand (`cargo clippy`)
One way to use clippy is by installing clippy through cargo as a cargo
subcommand.
```terminal
cargo install clippy
```
Now you can run clippy by invoking `cargo clippy`, or
`cargo +nightly clippy` directly from a directory that is usually
compiled with stable.
In case you are not using rustup, you need to set the environment flag
`SYSROOT` during installation so clippy knows where to find `librustc` and
similar crates.
```terminal
SYSROOT=/path/to/rustc/sysroot cargo install clippy
```
### Optional dependency ### Optional dependency
If you want to make clippy an optional dependency, you can do the following: In some cases you might want to include clippy in your project directly, as an
optional dependency. To do this, just modify `Cargo.toml`:
In your `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
clippy = {version = "*", optional = true} clippy = { version = "*", optional = true }
[features]
default = []
``` ```
And, in your `main.rs` or `lib.rs`, add these lines: And, in your `main.rs` or `lib.rs`, add these lines:
@ -54,25 +71,18 @@ Instead of adding the `cfg_attr` attributes you can also run clippy on demand:
(the `-Z no trans`, while not necessary, will stop the compilation process after (the `-Z no trans`, while not necessary, will stop the compilation process after
typechecking (and lints) have completed, which can significantly reduce the runtime). typechecking (and lints) have completed, which can significantly reduce the runtime).
### As a cargo subcommand (`cargo clippy`) Alternatively, to only run clippy when testing:
An alternate way to use clippy is by installing clippy through cargo as a cargo ```toml
subcommand. [dev-dependencies]`
clippy = { version = "*" }
```terminal
cargo install clippy
``` ```
Now you can run clippy by invoking `cargo clippy`, or and add to `main.rs` or `lib.rs`:
`rustup run nightly cargo clippy` directly from a directory that is usually
compiled with stable.
In case you are not using rustup, you need to set the environment flag ```
`SYSROOT` during installation so clippy knows where to find `librustc` and #![cfg_attr(test, feature(plugin))]
similar crates. #![cfg_attr(test, plugin(clippy))]
```terminal
SYSROOT=/path/to/rustc/sysroot cargo install clippy
``` ```
### Running clippy from the command line without installing ### Running clippy from the command line without installing