fune/docs/code-quality/lint/linters/rustfmt.rst
emilfs 5ff804de2e Bug 1618487 - fix rstcheck linter warning. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D64557

--HG--
extra : moz-landing-system : lando
2020-03-02 10:40:30 +00:00

33 lines
787 B
ReStructuredText

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>`_