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 name                 | default | meaning
  10 ---------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  11 approx_constant      | warn    | the approximate of a known float constant (in `std::f64::consts` or `std::f32::consts`) is found; suggests to use the constant
  12 bad_bit_mask         | deny    | 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)
  13 box_vec              | warn    | usage of `Box<Vec<T>>`, vector elements are already on the heap
  14 cmp_nan              | deny    | comparisons to NAN (which will always return false, which is probably not intended)
  15 cmp_owned            | warn    | creating owned instances for comparing with others, e.g. `x == "foo".to_string()`
  16 collapsible_if       | 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() }`
  17 eq_op                | warn    | equal operands on both sides of a comparison or bitwise combination (e.g. `x == x`)
  18 float_cmp            | 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)
  19 identity_op          | warn    | using identity operations, e.g. `x + 0` or `y / 1`
  20 ineffective_bit_mask | warn    | expressions where a bit mask will be rendered useless by a comparison, e.g. `(x | 1) > 2`
  21 inline_always        | warn    | `#[inline(always)]` is a bad idea in most cases
  22 len_without_is_empty | warn    | traits and impls that have `.len()` but not `.is_empty()`
  23 len_zero             | warn    | checking `.len() == 0` or `.len() > 0` (or similar) when `.is_empty()` could be used instead
  24 let_and_return       | warn    | creating a let-binding and then immediately returning it like `let x = expr; x` at the end of a function
  25 let_unit_value       | warn    | creating a let binding to a value of unit type, which usually can't be used afterwards
  26 linkedlist           | warn    | usage of LinkedList, usually a vector is faster, or a more specialized data structure like a RingBuf
  27 modulo_one           | warn    | taking a number modulo 1, which always returns 0
  28 mut_mut              | warn    | usage of double-mut refs, e.g. `&mut &mut ...` (either copy'n'paste error, or shows a fundamental misunderstanding of references)
  29 needless_bool        | warn    | if-statements with plain booleans in the then- and else-clause, e.g. `if p { true } else { false }`
  30 needless_lifetimes   | warn    | using explicit lifetimes for references in function arguments when elision rules would allow omitting them
  31 needless_range_loop  | warn    | for-looping over a range of indices where an iterator over items would do
  32 needless_return      | warn    | using a return statement like `return expr;` where an expression would suffice
  33 non_ascii_literal    | allow   | using any literal non-ASCII chars in a string literal; suggests using the \\u escape instead
  34 option_unwrap_used   | warn    | using `Option.unwrap()`, which should at least get a better message using `expect()`
  35 precedence           | warn    | expressions where precedence may trip up the unwary reader of the source; suggests adding parentheses, e.g. `x << 2 + y` will be parsed as `x << (2 + y)`
  36 ptr_arg              | allow   | fn arguments of the type `&Vec<...>` or `&String`, suggesting to use `&[...]` or `&str` instead, respectively
  37 redundant_closure    | warn    | using redundant closures, i.e. `|a| foo(a)` (which can be written as just `foo`)
  38 result_unwrap_used   | allow   | using `Result.unwrap()`, which might be better handled
  39 single_match         | warn    | a match statement with a single nontrivial arm (i.e, where the other arm is `_ => {}`) is used; recommends `if let` instead
  40 str_to_string        | warn    | using `to_string()` on a str, which should be `to_owned()`
  41 string_add           | allow   | using `x + ..` where x is a `String`; suggests using `push_str()` instead
  42 string_add_assign    | allow   | using `x = x + ..` where x is a `String`; suggests using `push_str()` instead
  43 string_to_string     | warn    | calling `String.to_string()` which is a no-op
  44 toplevel_ref_arg     | warn    | a function argument is declared `ref` (i.e. `fn foo(ref x: u8)`, but not `fn foo((ref x, ref y): (u8, u8))`)
  45 zero_width_space     | deny    | using a zero-width space in a string literal, which is confusing
  46
  47 To use, add the following lines to your Cargo.toml:
  48
  49 ```
  50 [dependencies]
  51 clippy = "*"
  52 ```
  53
  54 More to come, please [file an issue](https://github.com/Manishearth/rust-clippy/issues) if you have ideas!
  55
  56 ##Usage
  57
  58 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.
  59
  60 Add in your `Cargo.toml`:
  61 ```toml
  62 [dependencies.clippy]
  63 git = "https://github.com/Manishearth/rust-clippy"
  64 ```
  65
  66 Sample `main.rs`:
  67 ```rust
  68 #![feature(plugin)]
  69
  70 #![plugin(clippy)]
  71
  72
  73 fn main(){
  74     let x = Some(1u8);
  75     match x {
  76         Some(y) => println!("{:?}", y),
  77         _ => ()
  78     }
  79 }
  80 ```
  81
  82 Produce this warning:
  83 ```
  84 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
  85 src/main.rs:8     match x {
  86 src/main.rs:9         Some(y) => println!("{:?}", y),
  87 src/main.rs:10         _ => ()
  88 src/main.rs:11     }
  89 src/main.rs:8:5: 11:6 help: Try
  90 if let Some(y) = x { println!("{:?}", y) }
  91 ```
  92
  93 You can add options  to `allow`/`warn`/`deny`:
  94 - the whole set using the `clippy` lint group (`#![deny(clippy)]`, etc)
  95 - only some lints (`#![deny(single_match, box_vec)]`, etc)
  96 - `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
  97
  98 Note: `deny` produces errors instead of warnings
  99
 100 To have cargo compile your crate with clippy without needing `#![plugin(clippy)]`
 101 in your code, you can use:
 102
 103 ```
 104 cargo rustc -- -L /path/to/clippy_so -Z extra-plugins=clippy
 105 ```
 106
 107 ##License
 108 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.