summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/rustfmt.rst
blob: eb7e75fa6b0a764a7dc8ecb38423bcfdacc5ae1e (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
Rustfmt
=======

`rustfmt <https://github.com/rust-lang/rustfmt>`__ is the tool for Rust coding style.

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

The mozlint integration of rustfmt can be run using mach:

.. parsed-literal::

    $ mach lint --linter rustfmt <file paths>


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

To enable rustfmt on new directory, add the path to the include
section in the :searchfox:`rustfmt.yml <tools/lint/rustfmt.yml>` file.


Autofix
-------

Rustfmt is reformatting the code by default. To highlight the results, we are using
the ``--check`` option.

Sources
-------

* :searchfox:`Configuration (YAML) <tools/lint/rustfmt.yml>`
* :searchfox:`Source <tools/lint/rust/__init__.py>`