doc/adding_lints.md

   1 ## Adding a new lint
   2
   3 You are probably here because you want to add a new lint to Clippy. If this is
   4 the first time you're contributing to Clippy, this document guides you through
   5 creating an example lint from scratch.
   6
   7 To get started, we will create a lint that detects functions called `foo`,
   8 because that's clearly a non-descriptive name.
   9
  10 * [Setup](#Setup)
  11 * [Testing](#Testing)
  12 * [Rustfix tests](#Rustfix-tests)
  13 * [Lint declaration](#Lint-declaration)
  14 * [Lint passes](#Lint-passes)
  15 * [Emitting a lint](#Emitting-a-lint)
  16 * [Adding the lint logic](#Adding-the-lint-logic)
  17 * [Author lint](#Author-lint)
  18 * [Documentation](#Documentation)
  19 * [Running rustfmt](#Running-rustfmt)
  20 * [Debugging](#Debugging)
  21 * [PR Checklist](#PR-Checklist)
  22 * [Cheatsheet](#Cheatsheet)
  23
  24 ### Setup
  25
  26 When working on Clippy, you will need the current git master version of rustc,
  27 which can change rapidly. Make sure you're working near rust-clippy's master,
  28 and use the `setup-toolchain.sh` script to configure the appropriate toolchain
  29 for the Clippy directory.
  30
  31 ### Testing
  32
  33 Let's write some tests first that we can execute while we iterate on our lint.
  34
  35 Clippy uses UI tests for testing. UI tests check that the output of Clippy is
  36 exactly as expected. Each test is just a plain Rust file that contains the code
  37 we want to check. The output of Clippy is compared against a `.stderr` file.
  38 Note that you don't have to create this file yourself, we'll get to
  39 generating the `.stderr` files further down.
  40
  41 We start by creating the test file at `tests/ui/foo_functions.rs`. It doesn't
  42 really matter what the file is called, but it's a good convention to name it
  43 after the lint it is testing, so `foo_functions.rs` it is.
  44
  45 Inside the file we put some examples to get started:
  46
  47 ```rust
  48 #![warn(clippy::foo_functions)]
  49
  50 // Impl methods
  51 struct A;
  52 impl A {
  53     pub fn fo(&self) {}
  54     pub fn foo(&self) {}
  55     pub fn food(&self) {}
  56 }
  57
  58 // Default trait methods
  59 trait B {
  60     pub fn fo(&self) {}
  61     pub fn foo(&self) {}
  62     pub fn food(&self) {}
  63 }
  64
  65 // Plain functions
  66 fn fo() {}
  67 fn foo() {}
  68 fn food() {}
  69
  70 fn main() {
  71     // We also don't want to lint method calls
  72     foo();
  73     let a = A;
  74     a.foo();
  75 }
  76
  77 ```
  78
  79 Now we can run the test with `TESTNAME=ui/foo_functions cargo uitest`.
  80 Currently this test will fail. If you go through the output you will see that we
  81 are told that `clippy::foo_functions` is an unknown lint, which is expected.
  82
  83 While we are working on implementing our lint, we can keep running the UI
  84 test. That allows us to check if the output is turning into what we want.
  85
  86 Once we are satisfied with the output, we need to run
  87 `tests/ui/update-all-references.sh` to update the `.stderr` file for our lint.
  88 Running `TESTNAME=ui/foo_functions cargo uitest` should pass then. When we
  89 commit our lint, we need to commit the generated `.stderr` files, too.
  90
  91 ### Rustfix tests
  92
  93 If the lint you are working on is making use of structured suggestions, the
  94 test file should include a `// run-rustfix` comment at the top. This will
  95 additionally run [rustfix](https://github.com/rust-lang-nursery/rustfix) for
  96 that test. Rustfix will apply the suggestions from the lint to the code of the
  97 test file and compare that to the contents of a `.fixed` file.
  98
  99 Use `tests/ui/update-all-references.sh` to automatically generate the
 100 `.fixed` file after running the tests.
 101
 102 With tests in place, let's have a look at implementing our lint now.
 103
 104 ### Testing manually
 105
 106 Manually testing against an example file can be useful if you have added some
 107 `println!`s and the test suite output becomes unreadable. To try Clippy with
 108 your local modifications, run `env CLIPPY_TESTS=true cargo run --bin
 109 clippy-driver -- -L ./target/debug input.rs` from the working copy root.
 110
 111 ### Lint declaration
 112
 113 We start by creating a new file in the `clippy_lints` crate. That's the crate
 114 where all the lint code is. We are going to call the file
 115 `clippy_lints/src/foo_functions.rs` and import some initial things we need:
 116
 117 ```rust
 118 use rustc::lint::{LintArray, LintPass, EarlyLintPass};
 119 use rustc::{declare_lint_pass, declare_tool_lint};
 120 ```
 121
 122 The next step is to provide a lint declaration. Lints are declared using the
 123 [`declare_clippy_lint!`][declare_clippy_lint] macro:
 124
 125 ```rust
 126 declare_clippy_lint! {
 127     pub FOO_FUNCTIONS,
 128     pedantic,
 129     "function named `foo`, which is not a descriptive name"
 130 }
 131 ```
 132
 133 * `FOO_FUNCTIONS` is the name of our lint. Be sure to follow the [lint naming
 134 guidelines][lint_naming] here when naming your lint. In short, the name should
 135 state the thing that is being checked for and read well when used with
 136 `allow`/`warn`/`deny`.
 137 * `pedantic` sets the lint level to `Allow`.
 138   The exact mapping can be found [here][category_level_mapping]
 139 * The last part should be a text that explains what exactly is wrong with the
 140   code
 141
 142 With our lint declaration done, we will now make sure that it is assigned to a
 143 lint pass:
 144
 145 ```rust
 146 // clippy_lints/src/foo_functions.rs
 147
 148 // .. imports and lint declaration ..
 149
 150 declare_lint_pass!(FooFunctions => [FOO_FUNCTIONS]);
 151
 152 impl EarlyLintPass for FooFunctions {}
 153 ```
 154
 155 Don't worry about the `name` method here. As long as it includes the name of the
 156 lint pass it should be fine.
 157
 158 Next we need to run `util/dev update_lints` to register the lint in various
 159 places, mainly in `clippy_lints/src/lib.rs`.
 160
 161 While `update_lints` automates some things, it doesn't automate everything. We
 162 will have to register our lint pass manually in the `register_plugins` function
 163 in `clippy_lints/src/lib.rs`:
 164
 165 ```rust
 166 reg.register_early_lint_pass(box foo_functions::FooFunctions);
 167 ```
 168
 169 This should fix the `unknown clippy lint: clippy::foo_functions` error that we
 170 saw when we executed our tests the first time. The next decision we have to make
 171 is which lint pass our lint is going to need.
 172
 173 ### Lint passes
 174
 175 Writing a lint that only checks for the name of a function means that we only
 176 have to deal with the AST and don't have to deal with the type system at all.
 177 This is good, because it makes writing this particular lint less complicated.
 178
 179 We have to make this decision with every new Clippy lint. It boils down to using
 180 either [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass].
 181
 182 In short, the `LateLintPass` has access to type information while the
 183 `EarlyLintPass` doesn't. If you don't need access to type information, use the
 184 `EarlyLintPass`. The `EarlyLintPass` is also faster. However linting speed
 185 hasn't really been a concern with Clippy so far.
 186
 187 Since we don't need type information for checking the function name, we are
 188 going to use the `EarlyLintPass`. It has to be imported as well, changing our
 189 imports to:
 190
 191 ```rust
 192 use rustc::lint::{LintArray, LintPass, EarlyLintPass, EarlyContext};
 193 use rustc::{declare_tool_lint, lint_array};
 194 ```
 195
 196 ### Emitting a lint
 197
 198 With UI tests and the lint declaration in place, we can start working on the
 199 implementation of the lint logic.
 200
 201 Let's start by implementing the `EarlyLintPass` for our `FooFunctions`:
 202
 203 ```rust
 204 impl EarlyLintPass for FooFunctions {
 205     fn check_fn(&mut self, cx: &EarlyContext<'_>, fn_kind: FnKind<'_>, _: &FnDecl, span: Span, _: NodeId) {
 206         // TODO: Emit lint here
 207     }
 208 }
 209 ```
 210
 211 We implement the [`check_fn`][check_fn] method from the
 212 [`EarlyLintPass`][early_lint_pass] trait. This gives us access to various
 213 information about the function that is currently being checked. More on that in
 214 the next section. Let's worry about the details later and emit our lint for
 215 *every* function definition first.
 216
 217 Depending on how complex we want our lint message to be, we can choose from a
 218 variety of lint emission functions. They can all be found in
 219 [`clippy_lints/src/utils/diagnostics.rs`][diagnostics].
 220
 221 `span_help_and_lint` seems most appropriate in this case. It allows us to
 222 provide an extra help message and we can't really suggest a better name
 223 automatically. This is how it looks:
 224
 225 ```rust
 226 impl EarlyLintPass for FooFunctions {
 227     fn check_fn(&mut self, cx: &EarlyContext<'_>, _: FnKind<'_>, _: &FnDecl, span: Span, _: NodeId) {
 228         span_help_and_lint(
 229             cx,
 230             FOO_FUNCTIONS,
 231             span,
 232             "function named `foo`",
 233             "consider using a more meaningful name"
 234         );
 235     }
 236 }
 237 ```
 238
 239 Running our UI test should now produce output that contains the lint message.
 240
 241 ### Adding the lint logic
 242
 243 Writing the logic for your lint will most likely be different from our example,
 244 so this section is kept rather short.
 245
 246 Using the [`check_fn`][check_fn] method gives us access to [`FnKind`][fn_kind]
 247 that has two relevant variants for us `FnKind::ItemFn` and `FnKind::Method`.
 248 Both provide access to the name of the function/method via an [`Ident`][ident].
 249
 250 With that we can expand our `check_fn` method to:
 251
 252 ```rust
 253 impl EarlyLintPass for FooFunctions {
 254     fn check_fn(&mut self, cx: &EarlyContext<'_>, fn_kind: FnKind<'_>, _: &FnDecl, span: Span, _: NodeId) {
 255         if is_foo_fn(fn_kind) {
 256             span_help_and_lint(
 257                 cx,
 258                 FOO_FUNCTIONS,
 259                 span,
 260                 "function named `foo`",
 261                 "consider using a more meaningful name"
 262             );
 263         }
 264     }
 265 }
 266 ```
 267
 268 We separate the lint conditional from the lint emissions because it makes the
 269 code a bit easier to read. In some cases this separation would also allow to
 270 write some unit tests (as opposed to only UI tests) for the separate function.
 271
 272 In our example, `is_foo_fn` looks like:
 273
 274 ```rust
 275 // use statements, impl EarlyLintPass, check_fn, ..
 276
 277 fn is_foo_fn(fn_kind: FnKind<'_>) -> bool {
 278     match fn_kind {
 279         FnKind::ItemFn(ident, ..) | FnKind::Method(ident, ..) => {
 280             ident.name == "foo"
 281         },
 282         FnKind::Closure(..) => false
 283     }
 284 }
 285 ```
 286
 287 Now we should also run the full test suite with `cargo test`. At this point
 288 running `cargo test` should produce the expected output. Remember to run
 289 `tests/ui/update-all-references.sh` to update the `.stderr` file.
 290
 291 `cargo test` (as opposed to `cargo uitest`) will also ensure that our lint
 292 implementation is not violating any Clippy lints itself.
 293
 294 That should be it for the lint implementation. Running `cargo test` should now
 295 pass.
 296
 297 ### Author lint
 298
 299 If you have trouble implementing your lint, there is also the internal `author`
 300 lint to generate Clippy code that detects the offending pattern. It does not
 301 work for all of the Rust syntax, but can give a good starting point.
 302
 303 The quickest way to use it, is the [Rust playground][play].rust-lang.org).
 304 Put the code you want to lint into the editor and add the `#[clippy::author]`
 305 attribute above the item. Then run Clippy via `Tools -> Clippy` and you should
 306 see the generated code in the output below.
 307
 308 [Here][author_example] is an example on the playground.
 309
 310 If the command was executed successfully, you can copy the code over to where
 311 you are implementing your lint.
 312
 313 ### Documentation
 314
 315 The final thing before submitting our PR is to add some documentation to our
 316 lint declaration.
 317
 318 Please document your lint with a doc comment akin to the following:
 319
 320 ```rust
 321 declare_clippy_lint! {
 322     /// **What it does:** Checks for ... (describe what the lint matches).
 323     ///
 324     /// **Why is this bad?** Supply the reason for linting the code.
 325     ///
 326     /// **Known problems:** None. (Or describe where it could go wrong.)
 327     ///
 328     /// **Example:**
 329     ///
 330     /// ```rust,ignore
 331     /// // Bad
 332     /// Insert a short example of code that triggers the lint
 333     ///
 334     /// // Good
 335     /// Insert a short example of improved code that doesn't trigger the lint
 336     /// ```
 337     pub FOO_FUNCTIONS,
 338     pedantic,
 339     "function named `foo`, which is not a descriptive name"
 340 }
 341 ```
 342
 343 Once your lint is merged, this documentation will show up in the [lint
 344 list][lint_list].
 345
 346 ### Running rustfmt
 347
 348 [Rustfmt](https://github.com/rust-lang/rustfmt) is a tool for formatting Rust code according
 349 to style guidelines. Your code has to be formatted by `rustfmt` before a PR can be merged.
 350
 351 It can be installed via `rustup`:
 352
 353 ```bash
 354 rustup component add rustfmt
 355 ```
 356
 357 Use `cargo fmt --all` to format the whole codebase.
 358
 359 ### Debugging
 360
 361 If you want to debug parts of your lint implementation, you can use the `dbg!`
 362 macro anywhere in your code. Running the tests should then include the debug
 363 output in the `stdout` part.
 364
 365 ### PR Checklist
 366
 367 Before submitting your PR make sure you followed all of the basic requirements:
 368
 369 - [ ] Followed [lint naming conventions][lint_naming]
 370 - [ ] Added passing UI tests (including committed `.stderr` file)
 371 - [ ] `cargo test` passes locally
 372 - [ ] Executed `util/dev update_lints`
 373 - [ ] Added lint documentation
 374 - [ ] Run `cargo fmt`
 375
 376 ### Cheatsheet
 377
 378 Here are some pointers to things you are likely going to need for every lint:
 379
 380 * [Clippy utils][utils] - Various helper functions. Maybe the function you need
 381   is already in here (`implements_trait`, `match_path`, `snippet`, etc)
 382 * [Clippy diagnostics][diagnostics]
 383 * [The `if_chain` macro][if_chain]
 384 * [`in_macro`][in_macro] and [`in_external_macro`][in_external_macro]
 385 * [`Span`][span]
 386 * [`Applicability`][applicability]
 387 * [The rustc guide][rustc_guide] explains a lot of internal compiler concepts
 388 * [The nightly rustc docs][nightly_docs] which has been linked to throughout
 389   this guide
 390
 391 For `EarlyLintPass` lints:
 392
 393 * [`EarlyLintPass`][early_lint_pass]
 394 * [`syntax::ast`][ast]
 395
 396 For `LateLintPass` lints:
 397
 398 * [`LateLintPass`][late_lint_pass]
 399 * [`Ty::TyKind`][ty]
 400
 401
 402 While most of Clippy's lint utils are documented, most of rustc's internals lack
 403 documentation currently. This is unfortunate, but in most cases you can probably
 404 get away with copying things from existing similar lints. If you are stuck,
 405 don't hesitate to ask on Discord, IRC or in the issue/PR.
 406
 407 [lint_list]: https://rust-lang.github.io/rust-clippy/master/index.html
 408 [lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints
 409 [category_level_mapping]: https://github.com/rust-lang/rust-clippy/blob/bd23cb89ec0ea63403a17d3fc5e50c88e38dd54f/clippy_lints/src/lib.rs#L43
 410 [declare_clippy_lint]: https://github.com/rust-lang/rust-clippy/blob/a71acac1da7eaf667ab90a1d65d10e5cc4b80191/clippy_lints/src/lib.rs#L39
 411 [compilation_stages]: https://rust-lang.github.io/rustc-guide/high-level-overview.html#the-main-stages-of-compilation
 412 [check_fn]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.EarlyLintPass.html#method.check_fn
 413 [early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.EarlyLintPass.html
 414 [late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.LateLintPass.html
 415 [fn_kind]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/visit/enum.FnKind.html
 416 [diagnostics]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/diagnostics.rs
 417 [utils]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/mod.rs
 418 [ident]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/source_map/symbol/struct.Ident.html
 419 [span]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax_pos/struct.Span.html
 420 [applicability]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/enum.Applicability.html
 421 [if_chain]: https://docs.rs/if_chain/0.1.2/if_chain/
 422 [ty]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty/sty/index.html
 423 [ast]: https://doc.rust-lang.org/nightly/nightly-rustc/syntax/ast/index.html
 424 [in_macro]: https://github.com/rust-lang/rust-clippy/blob/d0717d1f9531a03d154aaeb0cad94c243915a146/clippy_lints/src/utils/mod.rs#L94
 425 [in_external_macro]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/fn.in_external_macro.html
 426 [play]: https://play.rust-lang.org
 427 [author_example]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=f093b986e80ad62f3b67a1f24f5e66e2
 428 [rustc_guide]: https://rust-lang.github.io/rustc-guide/
 429 [nightly_docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/