A collection of lints to catch common mistakes and improve your Rust code.
There are 93 lints included in this crate:
name | default | meaning
---------------------------------------------------------------------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
approxconstant | warn | the approximate of a known float constant (in std::f64::consts or std::f32::consts) is found; suggests to use the constant
badbitmask | warn | expressions of the form _ & mask == select that will only ever return true or false (because in the example select containing bits that mask doesn't have)
blockinifconditionexpr | warn | braces can be eliminated in conditions that are expressions, e.g if { true } ...
blockinifconditionstmt | warn | avoid complex blocks in conditions, instead move the block higher and bind it with 'let'; e.g: if { let x = true; x } ...
boxvec | warn | usage of Box<Vec<T>>, vector elements are already on the heap
boxedlocal | warn | using Boxx as u8 where x: u32, or x as i32 where x: f32
castpossiblewrap | allow | casts that may cause wrapping around the value, e.g x as i32 where x: u32 and x > i32::MAX
castprecisionloss | allow | casts that cause loss of precision, e.g x as f32 where x: u64
castsignloss | allow | casts from signed types to unsigned types, e.g x as u32 where x: i32
cmpnan | deny | comparisons to NAN (which will always return false, which is probably not intended)
cmpowned | warn | creating owned instances for comparing with others, e.g. x == "foo".to_string()
collapsibleif | warn | two nested if-expressions can be collapsed into one, e.g. if x { if y { foo() } } can be written as if x && y { foo() }
cyclomaticcomplexity | warn | finds functions that should be split up into multiple functions
deprecatedsemver | warn | Warn on #[deprecated(since = "x")] where x is not semver
duplicateunderscoreargument | warn | Function arguments having names which only differ by an underscore
emptyloop | warn | empty loop {} detected
eqop | warn | equal operands on both sides of a comparison or bitwise combination (e.g. x == x)
explicitcounterloop | warn | for-looping with an explicit counter when _.enumerate() would do
explicititerloop | warn | for-looping over _.iter() or _.iter_mut() when &_ or &mut _ would do
filternext | warn | using filter(p).next(), which is more succinctly expressed as .find(p)
floatcmp | warn | using == or != on float values (as floating-point operations usually involve rounding errors, it is always better to check for approximate equality within small bounds)
identityop | warn | using identity operations, e.g. x + 0 or y / 1
ineffectivebitmask | warn | expressions where a bit mask will be rendered useless by a comparison, e.g. (x | 1) > 2
inlinealways | warn | #[inline(always)] is a bad idea in most cases
iternextloop | warn | for-looping over _.next() which is probably not intended
lenwithoutisempty | warn | traits and impls that have .len() but not .is_empty()
lenzero | warn | checking .len() == 0 or .len() > 0 (or similar) when .is_empty() could be used instead
letandreturn | warn | creating a let-binding and then immediately returning it like let x = expr; x at the end of a block
letunitvalue | warn | creating a let binding to a value of unit type, which usually can't be used afterwards
linkedlist | warn | usage of LinkedList, usually a vector is faster, or a more specialized data structure like a VecDeque
mapclone | warn | using .map(|x| x.clone()) to clone an iterator or option's contents (recommends .cloned() instead)
mapentry | warn | use of contains_key followed by insert on a HashMap or BTreeMap
matchbool | warn | a match on boolean expression; recommends if..else block instead
matchoverlappingarm | warn | a match has overlapping arms
matchrefpats | warn | a match or if let has all arms prefixed with &; the match expression can be dereferenced instead
minmax | warn | min(_, max(_, _)) (or vice versa) with bounds clamping the result to a constant
moduloone | warn | taking a number modulo 1, which always returns 0
mutmut | allow | usage of double-mut refs, e.g. &mut &mut ... (either copy'n'paste error, or shows a fundamental misunderstanding of references)
mutexatomic | warn | using a Mutex where an atomic value could be used instead
mutexinteger | allow | using a Mutex for an integer type
needlessbool | warn | if-statements with plain booleans in the then- and else-clause, e.g. if p { true } else { false }
needlesslifetimes | warn | using explicit lifetimes for references in function arguments when elision rules would allow omitting them
needlessrangeloop | warn | for-looping over a range of indices where an iterator over items would do
needlessreturn | warn | using a return statement like return expr; where an expression would suffice
needlessupdate | warn | using { ..base } when there are no missing fields
noeffect | warn | statements with no effect
nonasciiliteral | allow | using any literal non-ASCII chars in a string literal; suggests using the \u escape instead
nonsensicalopenoptions | warn | nonsensical combination of options for opening a file
okexpect | warn | using ok().expect(), which gives worse error messages than calling expect directly on the Result
optionmapunwrapor | warn | using Option.map(f).unwrap_or(a), which is more succinctly expressed as map_or(a, f)
optionmapunwraporelse | warn | using Option.map(f).unwrap_or_else(g), which is more succinctly expressed as map_or_else(g, f)
optionunwrapused | allow | using Option.unwrap(), which should at least get a better message using expect()
orfuncall | warn | using any *or method when the *or_else would do
outofboundsindexing | deny | out of bound constant indexing
panicparams | warn | missing parameters in panic!
precedence | warn | catches operations where precedence may be unclear. See the wiki for a list of cases caught
ptrarg | warn | fn arguments of the type &Vec<...> or &String, suggesting to use &[...] or &str instead, respectively
rangestepbyzero | warn | using Range::stepby(0), which produces an infinite iterator
rangezipwithlen | warn | zipping iterator with a range when enumerate() would do
redundantclosure | warn | using redundant closures, i.e. |a| foo(a) (which can be written as just foo)
redundantpattern | warn | using name @ _ in a pattern
resultunwrapused | allow | using Result.unwrap(), which might be better handled
reverserangeloop | warn | Iterating over an empty range, such as 10..0 or 5..5
searchissome | warn | using an iterator search followed by is_some(), which is more succinctly expressed as a call to any()
shadowreuse | allow | rebinding a name to an expression that re-uses the original value, e.g. let x = x + 1
shadowsame | allow | rebinding a name to itself, e.g. let mut x = &mut x
shadowunrelated | allow | The name is re-bound without even using the original value
shouldimplementtrait | warn | defining a method that should be implementing a std trait
singlematch | warn | a match statement with a single nontrivial arm (i.e, where the other arm is _ => {}) is used; recommends if let instead
strtostring | warn | using to_string() on a str, which should be to_owned()
stringadd | allow | using x + .. where x is a String; suggests using push_str() instead
stringaddassign | allow | using x = x + .. where x is a String; suggests using push_str() instead
stringtostring | warn | calling String.to_string() which is a no-op
temporaryassignment | warn | assignments to temporaries
toplevelrefarg | warn | An entire binding was declared as ref, in a function argument (fn foo(ref x: Bar)), or a let statement (let ref x = foo()). In such cases, it is preferred to take references with &.
typecomplexity | warn | usage of very complex types; recommends factoring out parts into type definitions
unicodenotnfc | allow | using a unicode literal not in NFC normal form (see http://www.unicode.org/reports/tr15/ for further information)
unitcmp | warn | comparing unit values (which is always true or false, respectively)
unnecessarymutpassed | warn | an argument is passed as a mutable reference although the function/method only demands an immutable reference
unneededfieldpattern | warn | Struct fields are bound to a wildcard instead of using ..
unstableasmutslice | warn | asmutslice is not stable and can be replaced by &mut v[..]see https://github.com/rust-lang/rust/issues/27729
unstableasslice | warn | asslice is not stable and can be replaced by & v[..]see https://github.com/rust-lang/rust/issues/27729
unusedcollect | warn | collect()ing an iterator without using the result; this is usually better written as a for loop
unusedlifetimes | warn | unused lifetimes in function definitions
usedunderscorebinding | warn | using a binding which is prefixed with an underscore
uselesstransmute | warn | transmutes that have the same to and from types
whileletloop | warn | loop { if let { ... } else break } can be written as a while let loop
whileletoniterator | warn | using a while-let loop instead of a for loop on an iterator
wrongpubselfconvention | allow | defining a public method named with an established prefix (like "into") that takes self with the wrong convention
wrongselfconvention | warn | defining a method named with an established prefix (like "into") that takes self with the wrong convention
zerodividedbyzero | warn | usage of 0.0 / 0.0 to obtain NaN instead of std::f32::NaN or std::f64::NaN
zerowidth_space | deny | using a zero-width space in a string literal, which is confusing
More to come, please file an issue if you have ideas!
Compiler plugins are highly unstable and will only work with a nightly Rust for now. Since stable Rust is backwards compatible, you should be able to compile your stable programs with nightly Rust with clippy plugged in to circumvent this.
Add in your Cargo.toml:
toml
[dependencies]
clippy = "*"
You may also use cargo clippy, a custom cargo subcommand that runs clippy on a given project.
Sample main.rs:
```rust
fn main(){ let x = Some(1u8); match x { Some(y) => println!("{:?}", y), _ => () } } ```
Produces this warning:
src/main.rs:8:5: 11:6 warning: you seem to be trying to use match for destructuring a single type. Consider using `if let`, #[warn(single_match)] on by default
src/main.rs:8 match x {
src/main.rs:9 Some(y) => println!("{:?}", y),
src/main.rs:10 _ => ()
src/main.rs:11 }
src/main.rs:8:5: 11:6 help: Try
if let Some(y) = x { println!("{:?}", y) }
You can add options to allow/warn/deny:
- the whole set of Warn lints using the clippy lint group (#![deny(clippy)])
- all lints using both the clippy and clippy_pedantic lint groups (#![deny(clippy)], #![deny(clippy_pedantic)]). Note that clippy_pedantic contains some very aggressive lints prone to false positives.
- only some lints (#![deny(single_match, 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
To have cargo compile your crate with clippy without needing #![plugin(clippy)]
in your code, you can use:
cargo rustc -- -L /path/to/clippy_so -Z extra-plugins=clippy
Note: Be sure that clippy was compiled with the same version of rustc that cargo invokes here!
If you want to make clippy an optional dependency, you can do the following:
In your Cargo.toml:
```toml
[dependencies]
clippy = {version = "*", optional = true}
[features] default=[] ```
And, in your main.rs or lib.rs:
```rust
```
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.