CONTRIBUTING.md

   1 # Contributing to 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` or meet us in `#wg-clippy` on [Discord](https://discord.gg/rust-lang).
  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 fn main() {
  84     #[clippy::author]
  85     let arr: [i32; 1] = [7]; // Replace line with the code you want to match
  86 }
  87 ```
  88
  89 Now you run `TESTNAME=ui/my_lint cargo test --test compile-test` to produce
  90 a `.stdout` file with the generated code:
  91
  92 ```rust
  93 // ./tests/ui/my_lint.stdout
  94
  95 if_chain! {
  96     if let ExprKind::Array(ref elements) = stmt.node;
  97     if elements.len() == 1;
  98     if let ExprKind::Lit(ref lit) = elements[0].node;
  99     if let LitKind::Int(7, _) = lit.node;
 100     then {
 101         // report your lint here
 102     }
 103 }
 104 ```
 105
 106 If the command was executed successfully, you can copy the code over to where you are implementing your lint.
 107
 108 ### Documentation
 109
 110 Please document your lint with a doc comment akin to the following:
 111
 112 ```rust
 113 /// **What it does:** Checks for ... (describe what the lint matches).
 114 ///
 115 /// **Why is this bad?** Supply the reason for linting the code.
 116 ///
 117 /// **Known problems:** None. (Or describe where it could go wrong.)
 118 ///
 119 /// **Example:**
 120 ///
 121 /// ```rust
 122 /// // Bad
 123 /// Insert a short example of code that triggers the lint
 124 ///
 125 /// // Good
 126 /// Insert a short example of improved code that doesn't trigger the lint
 127 /// ```
 128 ```
 129
 130 Once your lint is merged it will show up in the [lint list](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
 131
 132 ### Running test suite
 133
 134 Use `cargo test` to run the whole testsuite.
 135
 136 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:
 137
 138 ```bash
 139 TESTNAME=ui/empty_line_after_outer_attr cargo test --test compile-test
 140 ```
 141
 142 Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
 143 Of course there's little sense in writing the output yourself or copying it around.
 144 Therefore you should use `tests/ui/update-all-references.sh` (after running
 145 `cargo test`) and check whether the output looks as you expect with `git diff`. Commit all
 146 `*.stderr` files, too.
 147
 148 ### Testing manually
 149
 150 Manually testing against an example file is useful if you have added some
 151 `println!`s and test suite output becomes unreadable.  To try Clippy with your
 152 local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
 153 working copy root.
 154
 155 ### How Clippy works
 156
 157 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.
 158
 159 [`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:
 160
 161 ```rust
 162 // ./clippy_lints/src/lib.rs
 163
 164 // ...
 165 pub mod else_if_without_else;
 166 // ...
 167
 168 pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
 169     // ...
 170     reg.register_early_lint_pass(box else_if_without_else::ElseIfWithoutElse);
 171     // ...
 172
 173     reg.register_lint_group("clippy_restriction", vec![
 174         // ...
 175         else_if_without_else::ELSE_IF_WITHOUT_ELSE,
 176         // ...
 177     ]);
 178 }
 179 ```
 180
 181 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].
 182 Both take an object that implements an [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass] respectively. This is done in every single lint.
 183 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.
 184
 185 ```rust
 186 // ./clippy_lints/src/else_if_without_else.rs
 187
 188 use rustc::lint::{EarlyLintPass, LintArray, LintPass};
 189
 190 // ...
 191
 192 pub struct ElseIfWithoutElse;
 193
 194 // ...
 195
 196 impl EarlyLintPass for ElseIfWithoutElse {
 197     // ... the functions needed, to make the lint work
 198 }
 199 ```
 200
 201 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.
 202
 203 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.
 204
 205 ### Fixing nightly build failures
 206
 207 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.
 208
 209 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].
 210 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.
 211
 212 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.
 213
 214 Fixing nightly build failures is also a good way to learn about actual rustc internals.
 215
 216 ## Contributions
 217
 218 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
 219 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
 220 main tree or given feedback for changes that would be required.
 221
 222 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
 223
 224 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->
 225
 226 [main_entry]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/src/lib.rs#L14
 227 [lint_crate]: https://github.com/rust-lang-nursery/rust-clippy/tree/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src
 228 [lint_crate_entry]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/lib.rs
 229 [else_if_without_else]: https://github.com/rust-lang-nursery/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/else_if_without_else.rs
 230 [compiler_plugin]: https://doc.rust-lang.org/unstable-book/language-features/plugin.html#lint-plugins
 231 [plugin_registry]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html
 232 [reg_early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_early_lint_pass
 233 [reg_late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_late_lint_pass
 234 [early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.EarlyLintPass.html
 235 [late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.LateLintPass.html
 236 [toolstate_commit_history]: https://github.com/rust-lang-nursery/rust-toolstate/commits/master
 237 [toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547