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.
7 To get started, we will create a lint that detects functions called `foo`,
8 because that's clearly a non-descriptive name.
10 - [Adding a new lint](#adding-a-new-lint)
12 - [Getting Started](#getting-started)
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 - [Adding configuration to a lint](#adding-configuration-to-a-lint)
27 - [Cheatsheet](#cheatsheet)
31 See the [Basics](basics.md#get-the-code) documentation.
35 There is a bit of boilerplate code that needs to be set up when creating a new
36 lint. Fortunately, you can use the clippy dev tools to handle this for you. We
37 are naming our new lint `foo_functions` (lints are generally written in snake
38 case), and we don't need type information so it will have an early pass type
39 (more on this later on). If you're not sure if the name you chose fits the lint,
40 take a look at our [lint naming guidelines][lint_naming]. To get started on this
41 lint you can run `cargo dev new_lint --name=foo_functions --pass=early
42 --category=pedantic` (category will default to nursery if not provided). This
43 command will create two files: `tests/ui/foo_functions.rs` and
44 `clippy_lints/src/foo_functions.rs`, as well as run `cargo dev update_lints` to
45 register the new lint. For cargo lints, two project hierarchies (fail/pass) will
46 be created by default under `tests/ui-cargo`.
48 Next, we'll open up these files and add our lint!
52 Let's write some tests first that we can execute while we iterate on our lint.
54 Clippy uses UI tests for testing. UI tests check that the output of Clippy is
55 exactly as expected. Each test is just a plain Rust file that contains the code
56 we want to check. The output of Clippy is compared against a `.stderr` file.
57 Note that you don't have to create this file yourself, we'll get to
58 generating the `.stderr` files further down.
60 We start by opening the test file created at `tests/ui/foo_functions.rs`.
62 Update the file with some examples to get started:
65 #![warn(clippy::foo_functions)]
75 // Default trait methods
88 // We also don't want to lint method calls
95 Now we can run the test with `TESTNAME=foo_functions cargo uitest`,
96 currently this test is meaningless though.
98 While we are working on implementing our lint, we can keep running the UI
99 test. That allows us to check if the output is turning into what we want.
101 Once we are satisfied with the output, we need to run
102 `cargo dev bless` to update the `.stderr` file for our lint.
103 Please note that, we should run `TESTNAME=foo_functions cargo uitest`
104 every time before running `cargo dev bless`.
105 Running `TESTNAME=foo_functions cargo uitest` should pass then. When we commit
106 our lint, we need to commit the generated `.stderr` files, too. In general, you
107 should only commit files changed by `cargo dev bless` for the
108 specific lint you are creating/editing. Note that if the generated files are
109 empty, they should be removed.
111 Note that you can run multiple test files by specifying a comma separated list:
112 `TESTNAME=foo_functions,test2,test3`.
116 For cargo lints, the process of testing differs in that we are interested in
117 the `Cargo.toml` manifest file. We also need a minimal crate associated
120 If our new lint is named e.g. `foo_categories`, after running `cargo dev new_lint`
121 we will find by default two new crates, each with its manifest file:
123 * `tests/ui-cargo/foo_categories/fail/Cargo.toml`: this file should cause the new lint to raise an error.
124 * `tests/ui-cargo/foo_categories/pass/Cargo.toml`: this file should not trigger the lint.
126 If you need more cases, you can copy one of those crates (under `foo_categories`) and rename it.
128 The process of generating the `.stderr` file is the same, and prepending the `TESTNAME`
129 variable to `cargo uitest` works too.
133 If the lint you are working on is making use of structured suggestions, the
134 test file should include a `// run-rustfix` comment at the top. This will
135 additionally run [rustfix] for that test. Rustfix will apply the suggestions
136 from the lint to the code of the test file and compare that to the contents of
139 Use `cargo dev bless` to automatically generate the
140 `.fixed` file after running the tests.
142 [rustfix]: https://github.com/rust-lang/rustfix
144 ## Edition 2018 tests
146 Some features require the 2018 edition to work (e.g. `async_await`), but
147 compile-test tests run on the 2015 edition by default. To change this behavior
148 add `// edition:2018` at the top of the test file (note that it's space-sensitive).
152 Manually testing against an example file can be useful if you have added some
153 `println!`s and the test suite output becomes unreadable. To try Clippy with
154 your local modifications, run
157 env __CLIPPY_INTERNAL_TESTS=true cargo run --bin clippy-driver -- -L ./target/debug input.rs
160 from the working copy root. With tests in place, let's have a look at
161 implementing our lint now.
165 Let's start by opening the new file created in the `clippy_lints` crate
166 at `clippy_lints/src/foo_functions.rs`. That's the crate where all the
167 lint code is. This file has already imported some initial things we will need:
170 use rustc_lint::{EarlyLintPass, EarlyContext};
171 use rustc_session::{declare_lint_pass, declare_tool_lint};
172 use rustc_ast::ast::*;
175 The next step is to update the lint declaration. Lints are declared using the
176 [`declare_clippy_lint!`][declare_clippy_lint] macro, and we just need to update
177 the auto-generated lint declaration to have a real description, something like this:
180 declare_clippy_lint! {
181 /// **What it does:**
183 /// **Why is this bad?**
185 /// **Known problems:** None.
194 "function named `foo`, which is not a descriptive name"
198 * The section of lines prefixed with `///` constitutes the lint documentation
199 section. This is the default documentation style and will be displayed
200 [like this][example_lint_page]. To render and open this documentation locally
201 in a browser, run `cargo dev serve`.
202 * `FOO_FUNCTIONS` is the name of our lint. Be sure to follow the
203 [lint naming guidelines][lint_naming] here when naming your lint.
204 In short, the name should state the thing that is being checked for and
205 read well when used with `allow`/`warn`/`deny`.
206 * `pedantic` sets the lint level to `Allow`.
207 The exact mapping can be found [here][category_level_mapping]
208 * The last part should be a text that explains what exactly is wrong with the
211 The rest of this file contains an empty implementation for our lint pass,
212 which in this case is `EarlyLintPass` and should look like this:
215 // clippy_lints/src/foo_functions.rs
217 // .. imports and lint declaration ..
219 declare_lint_pass!(FooFunctions => [FOO_FUNCTIONS]);
221 impl EarlyLintPass for FooFunctions {}
224 Normally after declaring the lint, we have to run `cargo dev update_lints`,
225 which updates some files, so Clippy knows about the new lint. Since we used
226 `cargo dev new_lint ...` to generate the lint declaration, this was done
227 automatically. While `update_lints` automates most of the things, it doesn't
228 automate everything. We will have to register our lint pass manually in the
229 `register_plugins` function in `clippy_lints/src/lib.rs`:
232 store.register_early_pass(|| box foo_functions::FooFunctions);
235 As one may expect, there is a corresponding `register_late_pass` method
236 available as well. Without a call to one of `register_early_pass` or
237 `register_late_pass`, the lint pass in question will not be run.
239 One reason that `cargo dev` does not automate this step is that multiple lints
240 can use the same lint pass, so registering the lint pass may already be done
241 when adding a new lint. Another reason that this step is not automated is that
242 the order that the passes are registered determines the order the passes
243 actually run, which in turn affects the order that any emitted lints are output
246 [declare_clippy_lint]: https://github.com/rust-lang/rust-clippy/blob/557f6848bd5b7183f55c1e1522a326e9e1df6030/clippy_lints/src/lib.rs#L60
247 [example_lint_page]: https://rust-lang.github.io/rust-clippy/master/index.html#redundant_closure
248 [lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints
249 [category_level_mapping]: https://github.com/rust-lang/rust-clippy/blob/557f6848bd5b7183f55c1e1522a326e9e1df6030/clippy_lints/src/lib.rs#L110
253 Writing a lint that only checks for the name of a function means that we only
254 have to deal with the AST and don't have to deal with the type system at all.
255 This is good, because it makes writing this particular lint less complicated.
257 We have to make this decision with every new Clippy lint. It boils down to using
258 either [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass].
260 In short, the `LateLintPass` has access to type information while the
261 `EarlyLintPass` doesn't. If you don't need access to type information, use the
262 `EarlyLintPass`. The `EarlyLintPass` is also faster. However linting speed
263 hasn't really been a concern with Clippy so far.
265 Since we don't need type information for checking the function name, we used
266 `--pass=early` when running the new lint automation and all the imports were
269 [early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html
270 [late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.LateLintPass.html
274 With UI tests and the lint declaration in place, we can start working on the
275 implementation of the lint logic.
277 Let's start by implementing the `EarlyLintPass` for our `FooFunctions`:
280 impl EarlyLintPass for FooFunctions {
281 fn check_fn(&mut self, cx: &EarlyContext<'_>, fn_kind: FnKind<'_>, span: Span, _: NodeId) {
282 // TODO: Emit lint here
287 We implement the [`check_fn`][check_fn] method from the
288 [`EarlyLintPass`][early_lint_pass] trait. This gives us access to various
289 information about the function that is currently being checked. More on that in
290 the next section. Let's worry about the details later and emit our lint for
291 *every* function definition first.
293 Depending on how complex we want our lint message to be, we can choose from a
294 variety of lint emission functions. They can all be found in
295 [`clippy_lints/src/utils/diagnostics.rs`][diagnostics].
297 `span_lint_and_help` seems most appropriate in this case. It allows us to
298 provide an extra help message and we can't really suggest a better name
299 automatically. This is how it looks:
302 impl EarlyLintPass for FooFunctions {
303 fn check_fn(&mut self, cx: &EarlyContext<'_>, fn_kind: FnKind<'_>, span: Span, _: NodeId) {
308 "function named `foo`",
310 "consider using a more meaningful name"
316 Running our UI test should now produce output that contains the lint message.
318 According to [the rustc-dev-guide], the text should be matter of fact and avoid
319 capitalization and periods, unless multiple sentences are needed.
320 When code or an identifier must appear in a message or label, it should be
321 surrounded with single grave accents \`.
323 [check_fn]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html#method.check_fn
324 [diagnostics]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/diagnostics.rs
325 [the rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/diagnostics.html
327 ## Adding the lint logic
329 Writing the logic for your lint will most likely be different from our example,
330 so this section is kept rather short.
332 Using the [`check_fn`][check_fn] method gives us access to [`FnKind`][fn_kind]
333 that has the [`FnKind::Fn`] variant. It provides access to the name of the
334 function/method via an [`Ident`][ident].
336 With that we can expand our `check_fn` method to:
339 impl EarlyLintPass for FooFunctions {
340 fn check_fn(&mut self, cx: &EarlyContext<'_>, fn_kind: FnKind<'_>, span: Span, _: NodeId) {
341 if is_foo_fn(fn_kind) {
346 "function named `foo`",
348 "consider using a more meaningful name"
355 We separate the lint conditional from the lint emissions because it makes the
356 code a bit easier to read. In some cases this separation would also allow to
357 write some unit tests (as opposed to only UI tests) for the separate function.
359 In our example, `is_foo_fn` looks like:
362 // use statements, impl EarlyLintPass, check_fn, ..
364 fn is_foo_fn(fn_kind: FnKind<'_>) -> bool {
366 FnKind::Fn(_, ident, ..) => {
367 // check if `fn` name is `foo`
368 ident.name.as_str() == "foo"
371 FnKind::Closure(..) => false
376 Now we should also run the full test suite with `cargo test`. At this point
377 running `cargo test` should produce the expected output. Remember to run
378 `cargo dev bless` to update the `.stderr` file.
380 `cargo test` (as opposed to `cargo uitest`) will also ensure that our lint
381 implementation is not violating any Clippy lints itself.
383 That should be it for the lint implementation. Running `cargo test` should now
386 [fn_kind]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/visit/enum.FnKind.html
387 [`FnKind::Fn`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/visit/enum.FnKind.html#variant.Fn
388 [ident]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/symbol/struct.Ident.html
390 ## Specifying the lint's minimum supported Rust version (msrv)
392 Projects supporting older versions of Rust would need to disable a lint if it targets features
393 present in later versions. Support for this can be added by specifying an msrv in your lint like so,
396 const MANUAL_STRIP_MSRV: RustcVersion = RustcVersion::new(1, 45, 0);
399 The project's msrv will also have to be an attribute in the lint so you'll have to add a struct
400 and constructor for your lint. The project's msrv needs to be passed when the lint is registered
404 pub struct ManualStrip {
405 msrv: Option<RustcVersion>,
410 pub fn new(msrv: Option<RustcVersion>) -> Self {
416 The project's msrv can then be matched against the lint's msrv in the LintPass using the `meets_msrv` utility
420 if !meets_msrv(self.msrv.as_ref(), &MANUAL_STRIP_MSRV) {
425 The project's msrv can also be specified as an inner attribute, which overrides the value from
426 `clippy.toml`. This can be accounted for using the `extract_msrv_attr!(LintContext)` macro and passing
427 LateContext/EarlyContext.
430 impl<'tcx> LateLintPass<'tcx> for ManualStrip {
431 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
434 extract_msrv_attr!(LateContext);
438 Once the msrv is added to the lint, a relevant test case should be added to `tests/ui/min_rust_version_attr.rs`
439 which verifies that the lint isn't emitted if the project's msrv is lower.
443 If you have trouble implementing your lint, there is also the internal `author`
444 lint to generate Clippy code that detects the offending pattern. It does not
445 work for all of the Rust syntax, but can give a good starting point.
447 The quickest way to use it, is the
448 [Rust playground: play.rust-lang.org][author_example].
449 Put the code you want to lint into the editor and add the `#[clippy::author]`
450 attribute above the item. Then run Clippy via `Tools -> Clippy` and you should
451 see the generated code in the output below.
453 [Here][author_example] is an example on the playground.
455 If the command was executed successfully, you can copy the code over to where
456 you are implementing your lint.
458 [author_example]: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2018&gist=9a12cb60e5c6ad4e3003ac6d5e63cf55
462 The final thing before submitting our PR is to add some documentation to our
465 Please document your lint with a doc comment akin to the following:
468 declare_clippy_lint! {
469 /// **What it does:** Checks for ... (describe what the lint matches).
471 /// **Why is this bad?** Supply the reason for linting the code.
473 /// **Known problems:** None. (Or describe where it could go wrong.)
479 /// Insert a short example of code that triggers the lint
482 /// Insert a short example of improved code that doesn't trigger the lint
486 "function named `foo`, which is not a descriptive name"
490 Once your lint is merged, this documentation will show up in the [lint
493 [lint_list]: https://rust-lang.github.io/rust-clippy/master/index.html
497 [Rustfmt] is a tool for formatting Rust code according to style guidelines.
498 Your code has to be formatted by `rustfmt` before a PR can be merged.
499 Clippy uses nightly `rustfmt` in the CI.
501 It can be installed via `rustup`:
504 rustup component add rustfmt --toolchain=nightly
507 Use `cargo dev fmt` to format the whole codebase. Make sure that `rustfmt` is
508 installed for the nightly toolchain.
510 [Rustfmt]: https://github.com/rust-lang/rustfmt
514 If you want to debug parts of your lint implementation, you can use the [`dbg!`]
515 macro anywhere in your code. Running the tests should then include the debug
516 output in the `stdout` part.
518 [`dbg!`]: https://doc.rust-lang.org/std/macro.dbg.html
522 Before submitting your PR make sure you followed all of the basic requirements:
524 <!-- Sync this with `.github/PULL_REQUEST_TEMPLATE` -->
526 - \[ ] Followed [lint naming conventions][lint_naming]
527 - \[ ] Added passing UI tests (including committed `.stderr` file)
528 - \[ ] `cargo test` passes locally
529 - \[ ] Executed `cargo dev update_lints`
530 - \[ ] Added lint documentation
531 - \[ ] Run `cargo dev fmt`
533 ## Adding configuration to a lint
535 Clippy supports the configuration of lints values using a `clippy.toml` file in the workspace
536 directory. Adding a configuration to a lint can be useful for thresholds or to constrain some
537 behavior that can be seen as a false positive for some users. Adding a configuration is done
538 in the following steps:
540 1. Adding a new configuration entry to [clippy_lints::utils::conf](/clippy_lints/src/utils/conf.rs)
543 /// Lint: LINT_NAME. <The configuration field doc comment>
544 (configuration_ident, "configuration_value": Type, DefaultValue),
546 The configuration value and identifier should usually be the same. The doc comment will be
547 automatically added to the lint documentation.
548 2. Adding the configuration value to the lint impl struct:
549 1. This first requires the definition of a lint impl struct. Lint impl structs are usually
550 generated with the `declare_lint_pass!` macro. This struct needs to be defined manually
551 to add some kind of metadata to it:
553 // Generated struct definition
554 declare_lint_pass!(StructName => [
558 // New manual definition struct
559 #[derive(Copy, Clone)]
560 pub struct StructName {}
562 impl_lint_pass!(StructName => [
567 2. Next add the configuration value and a corresponding creation method like this:
569 #[derive(Copy, Clone)]
570 pub struct StructName {
571 configuration_ident: Type,
577 pub fn new(configuration_ident: Type) -> Self {
584 3. Passing the configuration value to the lint impl struct:
586 First find the struct construction in the [clippy_lints lib file](/clippy_lints/src/lib.rs).
587 The configuration value is now cloned or copied into a local value that is then passed to the
588 impl struct like this:
590 // Default generated registration:
591 store.register_*_pass(|| box module::StructName);
593 // New registration with configuration value
594 let configuration_ident = conf.configuration_ident.clone();
595 store.register_*_pass(move || box module::StructName::new(configuration_ident));
598 Congratulations the work is almost done. The configuration value can now be accessed
599 in the linting code via `self.configuration_ident`.
602 1. The default configured value can be tested like any normal lint in [`tests/ui`](/tests/ui).
603 2. The configuration itself will be tested separately in [`tests/ui-toml`](/tests/ui-toml).
604 Simply add a new subfolder with a fitting name. This folder contains a `clippy.toml` file
605 with the configuration value and a rust file that should be linted by Clippy. The test can
606 otherwise be written as usual.
610 Here are some pointers to things you are likely going to need for every lint:
612 * [Clippy utils][utils] - Various helper functions. Maybe the function you need
613 is already in here (`implements_trait`, `match_path`, `snippet`, etc)
614 * [Clippy diagnostics][diagnostics]
615 * [The `if_chain` macro][if_chain]
616 * [`from_expansion`][from_expansion] and [`in_external_macro`][in_external_macro]
618 * [`Applicability`][applicability]
619 * [Common tools for writing lints](common_tools_writing_lints.md) helps with common operations
620 * [The rustc-dev-guide][rustc-dev-guide] explains a lot of internal compiler concepts
621 * [The nightly rustc docs][nightly_docs] which has been linked to throughout
624 For `EarlyLintPass` lints:
626 * [`EarlyLintPass`][early_lint_pass]
627 * [`rustc_ast::ast`][ast]
629 For `LateLintPass` lints:
631 * [`LateLintPass`][late_lint_pass]
634 While most of Clippy's lint utils are documented, most of rustc's internals lack
635 documentation currently. This is unfortunate, but in most cases you can probably
636 get away with copying things from existing similar lints. If you are stuck,
637 don't hesitate to ask on [Zulip] or in the issue/PR.
639 [utils]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/mod.rs
640 [if_chain]: https://docs.rs/if_chain/*/if_chain/
641 [from_expansion]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/struct.Span.html#method.from_expansion
642 [in_external_macro]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/lint/fn.in_external_macro.html
643 [span]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/struct.Span.html
644 [applicability]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/enum.Applicability.html
645 [rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
646 [nightly_docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
647 [ast]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/ast/index.html
648 [ty]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ty/sty/index.html
649 [Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/clippy