README.md

   1 #rust-clippy
   2 [![Build Status](https://travis-ci.org/Manishearth/rust-clippy.svg?branch=master)](https://travis-ci.org/Manishearth/rust-clippy)
   3
   4 A collection of lints that give helpful tips to newbies and catch oversights.
   5
   6 ##Lints
   7 Lints included in this crate:
   8
   9  - `single_match`: Warns when a match statement with a single nontrivial arm (i.e, where the other arm is `_ => {}`) is used, and recommends `if let` instead.
  10  - `box_vec`: Warns on usage of `Box<Vec<T>>`
  11  - `linkedlist`: Warns on usage of `LinkedList`
  12  - `str_to_string`: Warns on usage of `str::to_string()`
  13  - `toplevel_ref_arg`: Warns when a function argument is declared `ref` (i.e. `fn foo(ref x: u8)`, but not `fn foo((ref x, ref y): (u8, u8))`)
  14  - `eq_op`: Warns on equal operands on both sides of a comparison or bitwise combination
  15  - `bad_bit_mask`: Denies 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)
  16  - `ineffective_bit_mask`: Warns on expressions where a bit mask will be rendered useless by a comparison, e.g. `(x | 1) > 2`
  17  - `needless_bool` : Warns on if-statements with plain booleans in the then- and else-clause, e.g. `if p { true } else { false }`
  18  - `ptr_arg`: Warns on fn arguments of the type `&Vec<...>` or `&String`, suggesting to use `&[...]` or `&str` instead, respectively
  19  - `approx_constant`: Warns if the approximate of a known float constant (in `std::f64::consts` or `std::f32::consts`) is found and suggests to use the constant
  20  - `cmp_nan`: Denies comparisons to NAN (which will always return false, which is probably not intended)
  21  - `float_cmp`: Warns on `==` or `!=` comparisons of floaty typed values. As floating-point operations usually involve rounding errors, it is always better to check for approximate equality within some small bounds
  22  - `precedence`: Warns on expressions where precedence may trip up the unwary reader of the source and suggests adding parenthesis, e.g. `x << 2 + y` will be parsed as `x << (2 + y)`
  23  - `redundant_closure`: Warns on usage of eta-reducible closures like `|a| foo(a)` (which can be written as just `foo`)
  24  - `identity_op`: Warns on identity operations like `x + 0` or `y / 1` (which can be reduced to `x` and `y`, respectively)
  25  - `mut_mut`: Warns on `&mut &mut` which is either a copy'n'paste error, or shows a fundamental misunderstanding of references
  26  - `len_zero`: Warns on `_.len() == 0` and suggests using `_.is_empty()` (or similar comparisons with `>` or `!=`)
  27  - `len_without_is_empty`: Warns on traits or impls that have a `.len()` but no `.is_empty()` method
  28  - `cmp_owned`: Warns on creating owned instances for comparing with others, e.g. `x == "foo".to_string()`
  29  - `inline_always`: Warns on `#[inline(always)]`, because in most cases it is a bad idea
  30  - `collapsible_if`: Warns on cases where two nested `if`-expressions can be collapsed into one, e.g. `if x { if y { foo() } }` can be written as `if x && y { foo() }`
  31  - `zero_width_space`: Warns on encountering a unicode zero-width space
  32  - `string_add_assign`: Warns on `x = x + ..` where `x` is a `String` and suggests using `push_str(..)` instead.
  33  - `needless_return`: Warns on using `return expr;` when a simple `expr` would suffice.
  34  - `option_unwrap_used`: Warns when `Option.unwrap()` is used, and suggests `.expect()`.
  35  - `result_unwrap_used`: Warns when `Result.unwrap()` is used (silent by default).
  36  - `modulo_one`: Warns on taking a number modulo 1, which always has a result of 0.
  37
  38 To use, add the following lines to your Cargo.toml:
  39
  40 ```
  41 [dependencies]
  42 clippy = "*"
  43 ```
  44
  45 More to come, please [file an issue](https://github.com/Manishearth/rust-clippy/issues) if you have ideas!
  46
  47 ##Usage
  48
  49 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.
  50
  51 Add in your `Cargo.toml`:
  52 ```toml
  53 [dependencies.clippy]
  54 git = "https://github.com/Manishearth/rust-clippy"
  55 ```
  56
  57 Sample `main.rs`:
  58 ```rust
  59 #![feature(plugin)]
  60
  61 #![plugin(clippy)]
  62
  63
  64 fn main(){
  65     let x = Some(1u8);
  66     match x {
  67         Some(y) => println!("{:?}", y),
  68         _ => ()
  69     }
  70 }
  71 ```
  72
  73 Produce this warning:
  74 ```
  75 src/main.rs:8:5: 11:6 warning: You seem to be trying to use match for destructuring a single type. Did you mean to use `if let`?, #[warn(single_match)] on by default
  76 src/main.rs:8     match x {
  77 src/main.rs:9         Some(y) => println!("{:?}", y),
  78 src/main.rs:10         _ => ()
  79 src/main.rs:11     }
  80 src/main.rs:8:5: 11:6 note: Try if let Some(y) = x { ... }
  81 src/main.rs:8     match x {
  82 src/main.rs:9         Some(y) => println!("{:?}", y),
  83 src/main.rs:10         _ => ()
  84 src/main.rs:11     }
  85 ```
  86
  87 You can add options  to `allow`/`warn`/`deny`:
  88 - the whole set using the `clippy` lint group (`#![deny(clippy)]`, etc)
  89 - only some lints (`#![deny(single_match, box_vec)]`, etc)
  90 - `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
  91
  92 *`deny` produces error instead of warnings*
  93
  94 To have cargo compile your crate with clippy without needing `#![plugin(clippy)]`
  95 in your code, you can use:
  96
  97 ```
  98 cargo rustc -- -L /path/to/clippy_so -Z extra-plugins=clippy
  99 ```
 100
 101 ##License
 102 Licensed under [MPL](https://www.mozilla.org/MPL/2.0/). If you're having issues with the license, let me know and I'll try to change it to something more permissive.