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