fune/docs/code-quality/lint/linters/rustfmt.rst
Andrew Halberstadt e818e28315 Bug 1780087 - Convert some searchfox links under 'docs/code-quality' to the new role, r=linter-reviewers,sylvestre
This is more to demonstrate the use of the role than anything else.

Differential Revision: https://phabricator.services.mozilla.com/D152125
2022-07-19 15:41:08 +00:00

33 lines
679 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 :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>`