summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/clippy.rst
blob: 40db532b8836c9decbdb13a431df5fa2c970926d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
clippy
======

`clippy`_ is the tool for Rust static analysis.

Run Locally
-----------

The mozlint integration of clippy can be run using mach:

.. parsed-literal::

    $ mach lint --linter clippy <file paths>

.. note::

   clippy expects a path or a .rs file. It doesn't accept Cargo.toml
   as it would break the mozlint workflow.

Configuration
-------------

To enable clippy on new directory, add the path to the include
section in the `clippy.yml <https://searchfox.org/mozilla-central/source/tools/lint/clippy.yml>`_ file.

Autofix
-------

This linter provides a ``--fix`` option.
Please note that this option does not fix all detected issues.

Sources
-------

* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/clippy.yml>`_
* `Source <https://searchfox.org/mozilla-central/source/tools/lint/clippy/__init__.py>`_