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