CONTRIBUTING.md

   1 # Contributing to rust-clippy
   2
   3 Hello fellow Rustacean! Great to see your interest in compiler internals and lints!
   4
   5 **First**: if you're unsure or afraid of _anything_, just ask or submit the issue or pull request anyway. You won't be yelled at for giving it your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.
   6
   7 Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document explains how
   8 you can contribute and how to get started.
   9 If you have any questions about contributing or need help with anything, feel free to ask questions on issues or
  10 visit the `#clippy` IRC channel on `irc.mozilla.org`.
  11
  12 All contributors are expected to follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
  13
  14 * [Getting started](#getting-started)
  15   * [Finding something to fix/improve](#finding-something-to-fiximprove)
  16 * [Writing code](#writing-code)
  17   * [Author lint](#author-lint)
  18   * [Documentation](#documentation)
  19   * [Running test suite](#running-test-suite)
  20   * [Testing manually](#testing-manually)
  21   * [How Clippy works](#how-clippy-works)
  22   * [Fixing nightly build failures](#fixing-nightly-build-failures)
  23 * [Contributions](#contributions)
  24
  25 ## Getting started
  26
  27 High level approach:
  28
  29 1. Find something to fix/improve
  30 2. Change code (likely some file in `clippy_lints/src/`)
  31 3. Run `cargo test` in the root directory and wiggle code until it passes
  32 4. Open a PR (also can be done between 2. and 3. if you run into problems)
  33
  34 ### Finding something to fix/improve
  35
  36 All issues on Clippy are mentored, if you want help with a bug just ask @Manishearth, @llogiq, @mcarton or @oli-obk.
  37
  38 Some issues are easier than others. The [`good first issue`](https://github.com/rust-lang-nursery/rust-clippy/labels/good%20first%20issue)
  39 label can be used to find the easy issues. If you want to work on an issue, please leave a comment
  40 so that we can assign it to you!
  41
  42 Issues marked [`T-AST`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-AST) involve simple
  43 matching of the syntax tree structure, and are generally easier than
  44 [`T-middle`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-middle) issues, which involve types
  45 and resolved paths.
  46
  47 [`T-AST`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-AST) issues will generally need you to match against a predefined syntax structure. To figure out
  48 how this syntax structure is encoded in the AST, it is recommended to run `rustc -Z ast-json` on an
  49 example of the structure and compare with the
  50 [nodes in the AST docs](https://doc.rust-lang.org/nightly/nightly-rustc/syntax/ast). Usually
  51 the lint will end up to be a nested series of matches and ifs,
  52 [like so](https://github.com/rust-lang-nursery/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34).
  53
  54 [`E-medium`](https://github.com/rust-lang-nursery/rust-clippy/labels/E-medium) issues are generally
  55 pretty easy too, though it's recommended you work on an E-easy issue first. They are mostly classified
  56 as `E-medium`, since they might be somewhat involved code wise, but not difficult per-se.
  57
  58 [`T-middle`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-middle) issues can
  59 be more involved and require verifying types. The
  60 [`ty`](https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty) module contains a
  61 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
  62 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
  63
  64 ## Writing code
  65
  66 Compiling clippy from scratch can take almost a minute or more depending on your machine.
  67 However, since Rust 1.24.0 incremental compilation is enabled by default and compile times for small changes should be quick.
  68
  69 [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
  70 to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of
  71 `LintPass` with one or more of its default methods overridden. See the existing lints for examples
  72 of this.
  73
  74
  75 ### Author lint
  76
  77 There is also the internal `author` lint to generate clippy code that detects the offending pattern. It does not work for all of the Rust syntax, but can give a good starting point.
  78
  79 First, create a new UI test file in the `tests/ui/` directory with the pattern you want to match:
  80
  81 ```rust
  82 // ./tests/ui/my_lint.rs
  83
  84 // The custom_attribute needs to be enabled for the author lint to work
  85 #![feature(plugin, custom_attribute)]
  86
  87 fn main() {
  88     #[clippy(author)]
  89     let arr: [i32; 1] = [7]; // Replace line with the code you want to match
  90 }
  91 ```
  92
  93 Now you run `TESTNAME=ui/my_lint cargo test --test compile-test` to produce
  94 a `.stdout` file with the generated code:
  95
  96 ```rust
  97 // ./tests/ui/my_lint.stdout
  98
  99 if_chain! {
 100     if let Expr_::ExprArray(ref elements) = stmt.node;
 101     if elements.len() == 1;
 102     if let Expr_::ExprLit(ref lit) = elements[0].node;
 103     if let LitKind::Int(7, _) = lit.node;
 104     then {
 105         // report your lint here
 106     }
 107 }
 108 ```
 109
 110 If the command was executed successfully, you can copy the code over to where you are implementing your lint.
 111
 112 ### Documentation
 113
 114 Please document your lint with a doc comment akin to the following:
 115
 116 ```rust
 117 /// **What it does:** Checks for ... (describe what the lint matches).
 118 ///
 119 /// **Why is this bad?** Supply the reason for linting the code.
 120 ///
 121 /// **Known problems:** None. (Or describe where it could go wrong.)
 122 ///
 123 /// **Example:**
 124 ///
 125 /// ```rust
 126 /// // Bad
 127 /// Insert a short example of code that triggers the lint
 128 ///
 129 /// // Good
 130 /// Insert a short example of improved code that doesn't trigger the lint
 131 /// ```
 132 ```
 133
 134 Once your lint is merged it will show up in the [lint list](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
 135
 136 ### Running test suite
 137
 138 Use `cargo test` to run the whole testsuite.
 139
 140 If you don't want to wait for all tests to finish, you can also execute a single test file by using `TESTNAME` to specify the test to run:
 141
 142 ```bash
 143 TESTNAME=ui/empty_line_after_outer_attr cargo test --test compile-test
 144 ```
 145
 146 Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
 147 Of course there's little sense in writing the output yourself or copying it around.
 148 Therefore you should use `tests/ui/update-all-references.sh` (after running
 149 `cargo test`) and check whether the output looks as you expect with `git diff`. Commit all
 150 `*.stderr` files, too.
 151
 152 ### Testing manually
 153
 154 Manually testing against an example file is useful if you have added some
 155 `println!`s and test suite output becomes unreadable.  To try clippy with your
 156 local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
 157 working copy root.
 158
 159 ### How Clippy works
 160
 161 Clippy is a [rustc compiler plugin][compiler_plugin]. The main entry point is at [`src/lib.rs`][main_entry]. In there, the lint registration is delegated to the [`clippy_lints`][lint_crate] crate.
 162
 163 [`clippy_lints/src/lib.rs`][lint_crate_entry] imports all the different lint modules and registers them with the rustc plugin registry. For example, the [`else_if_without_else`][else_if_without_else] lint is registered like this:
 164
 165 ```rust
 166 // ./clippy_lints/src/lib.rs
 167
 168 // ...
 169 pub mod else_if_without_else;
 170 // ...
 171
 172 pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
 173     // ...
 174     reg.register_early_lint_pass(box else_if_without_else::ElseIfWithoutElse);
 175     // ...
 176
 177     reg.register_lint_group("clippy_restriction", vec![
 178         // ...
 179         else_if_without_else::ELSE_IF_WITHOUT_ELSE,
 180         // ...
 181     ]);
 182 }
 183 ```
 184
 185 The [`rustc_plugin::PluginRegistry`][plugin_registry] provides two methods to register lints: [register_early_lint_pass][reg_early_lint_pass] and [register_late_lint_pass][reg_late_lint_pass].
 186 Both take an object that implements an [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass] respectively. This is done in every single lint.
 187 It's worth noting that the majority of `clippy_lints/src/lib.rs` is autogenerated by `util/update_lints.py` and you don't have to add anything by hand. When you are writing your own lint, you can use that script to save you some time.
 188
 189 ```rust
 190 // ./clippy_lints/src/else_if_without_else.rs
 191
 192 use rustc::lint::*;
 193
 194 // ...
 195
 196 pub struct ElseIfWithoutElse;
 197
 198 // ...
 199
 200 impl EarlyLintPass for ElseIfWithoutElse {
 201     // ... the functions needed, to make the lint work
 202 }
 203 ```
 204
 205 The difference between `EarlyLintPass` and `LateLintPass` is that the methods of the `EarlyLintPass` trait only provide AST information. The methods of the `LateLintPass` trait are executed after type checking and contain type information via the `LateContext` parameter.
 206
 207 That's why the `else_if_without_else` example uses the `register_early_lint_pass` function. Because the [actual lint logic][else_if_without_else] does not depend on any type information.
 208
 209 ### Fixing nightly build failures
 210
 211 Clippy will sometimes break with new nightly version releases. This is expected because Clippy still depends on nightly Rust. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in rust.
 212
 213 In order to find out why Clippy does not work properly with a new nightly version, you can use the [rust-toolstate commit history][toolstate_commit_history].
 214 You will then have to look for the last commit that contains `test-pass -> build-fail` or `test-pass` -> `test-fail` for the `clippy-driver` component. [Here][toolstate_commit] is an example.
 215
 216 The commit message contains a link to the PR. The PRs are usually small enough to discover the breaking API change and if they are bigger, they likely include some discussion that may help you to fix Clippy.
 217
 218 Fixing nightly build failures is also a good way to learn about actual rustc internals.
 219
 220 ## Contributions
 221
 222 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
 223 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
 224 main tree or given feedback for changes that would be required.
 225
 226 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
 227
 228 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->
 229
 230 [main_entry]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/src/lib.rs#L14
 231 [lint_crate]: https://github.com/rust-lang-nursery/rust-clippy/tree/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src
 232 [lint_crate_entry]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/lib.rs
 233 [else_if_without_else]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/else_if_without_else.rs
 234 [compiler_plugin]: https://doc.rust-lang.org/unstable-book/language-features/plugin.html#lint-plugins
 235 [plugin_registry]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html
 236 [reg_early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_early_lint_pass
 237 [reg_late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_late_lint_pass
 238 [early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.EarlyLintPass.html
 239 [late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.LateLintPass.html
 240 [toolstate_commit_history]: https://github.com/rust-lang-nursery/rust-toolstate/commits/master
 241 [toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547