src/tools/clippy/book/src/development/basics.md

   1 # Basics for hacking on Clippy
   2
   3 This document explains the basics for hacking on Clippy. Besides others, this
   4 includes how to build and test Clippy. For a more in depth description on the
   5 codebase take a look at [Adding Lints] or [Common Tools].
   6
   7 [Adding Lints]: https://github.com/rust-lang/rust-clippy/blob/master/book/src/development/adding_lints.md
   8 [Common Tools]: https://github.com/rust-lang/rust-clippy/blob/master/book/src/development/common_tools_writing_lints.md
   9
  10 - [Basics for hacking on Clippy](#basics-for-hacking-on-clippy)
  11   - [Get the Code](#get-the-code)
  12   - [Building and Testing](#building-and-testing)
  13   - [`cargo dev`](#cargo-dev)
  14   - [lintcheck](#lintcheck)
  15   - [PR](#pr)
  16   - [Common Abbreviations](#common-abbreviations)
  17   - [Install from source](#install-from-source)
  18
  19 ## Get the Code
  20
  21 First, make sure you have checked out the latest version of Clippy. If this is
  22 your first time working on Clippy, create a fork of the repository and clone it
  23 afterwards with the following command:
  24
  25 ```bash
  26 git clone git@github.com:<your-username>/rust-clippy
  27 ```
  28
  29 If you've already cloned Clippy in the past, update it to the latest version:
  30
  31 ```bash
  32 # If the upstream remote has not been added yet
  33 git remote add upstream https://github.com/rust-lang/rust-clippy
  34 # upstream has to be the remote of the rust-lang/rust-clippy repo
  35 git fetch upstream
  36 # make sure that you are on the master branch
  37 git checkout master
  38 # rebase your master branch on the upstream master
  39 git rebase upstream/master
  40 # push to the master branch of your fork
  41 git push
  42 ```
  43
  44 ## Building and Testing
  45
  46 You can build and test Clippy like every other Rust project:
  47
  48 ```bash
  49 cargo build  # builds Clippy
  50 cargo test   # tests Clippy
  51 ```
  52
  53 Since Clippy's test suite is pretty big, there are some commands that only run a
  54 subset of Clippy's tests:
  55
  56 ```bash
  57 # only run UI tests
  58 cargo uitest
  59 # only run UI tests starting with `test_`
  60 TESTNAME="test_" cargo uitest
  61 # only run dogfood tests
  62 cargo dev dogfood
  63 ```
  64
  65 If the output of a [UI test] differs from the expected output, you can update
  66 the reference file with:
  67
  68 ```bash
  69 cargo dev bless
  70 ```
  71
  72 For example, this is necessary, if you fix a typo in an error message of a lint
  73 or if you modify a test file to add a test case.
  74
  75 > _Note:_ This command may update more files than you intended. In that case
  76 > only commit the files you wanted to update.
  77
  78 [UI test]: https://rustc-dev-guide.rust-lang.org/tests/adding.html#guide-to-the-ui-tests
  79
  80 ## `cargo dev`
  81
  82 Clippy has some dev tools to make working on Clippy more convenient. These tools
  83 can be accessed through the `cargo dev` command. Available tools are listed
  84 below. To get more information about these commands, just call them with
  85 `--help`.
  86
  87 ```bash
  88 # formats the whole Clippy codebase and all tests
  89 cargo dev fmt
  90 # register or update lint names/groups/...
  91 cargo dev update_lints
  92 # create a new lint and register it
  93 cargo dev new_lint
  94 # deprecate a lint and attempt to remove code relating to it
  95 cargo dev deprecate
  96 # automatically formatting all code before each commit
  97 cargo dev setup git-hook
  98 # (experimental) Setup Clippy to work with IntelliJ-Rust
  99 cargo dev setup intellij
 100 # runs the `dogfood` tests
 101 cargo dev dogfood
 102 ```
 103
 104 More about intellij command usage and reasons
 105 [here](https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md#intellij-rust)
 106
 107 ## lintcheck
 108
 109 `cargo lintcheck` will build and run clippy on a fixed set of crates and
 110 generate a log of the results.  You can `git diff` the updated log against its
 111 previous version and see what impact your lint made on a small set of crates.
 112 If you add a new lint, please audit the resulting warnings and make sure there
 113 are no false positives and that the suggestions are valid.
 114
 115 Refer to the tools [README] for more details.
 116
 117 [README]: https://github.com/rust-lang/rust-clippy/blob/master/lintcheck/README.md
 118
 119 ## PR
 120
 121 We follow a rustc no merge-commit policy. See
 122 <https://rustc-dev-guide.rust-lang.org/contributing.html#opening-a-pr>.
 123
 124 ## Common Abbreviations
 125
 126 | Abbreviation | Meaning                                |
 127 | ------------ | -------------------------------------- |
 128 | UB           | Undefined Behavior                     |
 129 | FP           | False Positive                         |
 130 | FN           | False Negative                         |
 131 | ICE          | Internal Compiler Error                |
 132 | AST          | Abstract Syntax Tree                   |
 133 | MIR          | Mid-Level Intermediate Representation  |
 134 | HIR          | High-Level Intermediate Representation |
 135 | TCX          | Type context                           |
 136
 137 This is a concise list of abbreviations that can come up during Clippy
 138 development. An extensive general list can be found in the [rustc-dev-guide
 139 glossary][glossary]. Always feel free to ask if an abbreviation or meaning is
 140 unclear to you.
 141
 142 ## Install from source
 143
 144 If you are hacking on Clippy and want to install it from source, do the
 145 following:
 146
 147 First, take note of the toolchain
 148 [override](https://rust-lang.github.io/rustup/overrides.html) in
 149 `/rust-toolchain`. We will use this override to install Clippy into the right
 150 toolchain.
 151
 152 > Tip: You can view the active toolchain for the current directory with `rustup
 153 > show active-toolchain`.
 154
 155 From the Clippy project root, run the following command to build the Clippy
 156 binaries and copy them into the toolchain directory. This will override the
 157 currently installed Clippy component.
 158
 159 ```terminal
 160 cargo build --release --bin cargo-clippy --bin clippy-driver -Zunstable-options --out-dir "$(rustc --print=sysroot)/bin"
 161 ```
 162
 163 Now you may run `cargo clippy` in any project, using the toolchain where you
 164 just installed Clippy.
 165
 166 ```terminal
 167 cd my-project
 168 cargo +nightly-2021-07-01 clippy
 169 ```
 170
 171 ...or `clippy-driver`
 172
 173 ```terminal
 174 clippy-driver +nightly-2021-07-01 <filename>
 175 ```
 176
 177 If you need to restore the default Clippy installation, run the following (from
 178 the Clippy project root).
 179
 180 ```terminal
 181 rustup component remove clippy
 182 rustup component add clippy
 183 ```
 184
 185 > **DO NOT** install using `cargo install --path . --force` since this will
 186 > overwrite rustup
 187 > [proxies](https://rust-lang.github.io/rustup/concepts/proxies.html). That is,
 188 > `~/.cargo/bin/cargo-clippy` and `~/.cargo/bin/clippy-driver` should be hard or
 189 > soft links to `~/.cargo/bin/rustup`. You can repair these by running `rustup
 190 > update`.
 191
 192 [glossary]: https://rustc-dev-guide.rust-lang.org/appendix/glossary.html