summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/rustfmt.rst
blob: 7ba3cd6c346949394eac7aec7f6403662e11baa0 (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 `rustfmt.yml <https://searchfox.org/mozilla-central/source/tools/lint/rustfmt.yml>`_ file.


Autofix
-------

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

Sources
-------

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