Bug 1617103 - Add documentation for yamllint. r=sylvestre DONTBUILD

Differential Revision: https://phabricator.services.mozilla.com/D154108
This commit is contained in:
Max Smolens
2022-08-09 19:13:45 +00:00
parent 79ada03558
commit e137b87d56
2 changed files with 33 additions and 2 deletions

View File

@@ -177,7 +177,7 @@ In this document, we try to list these all tools.
- :ref:`Fluent Lint`
-
* - YAML linter
- No
-
-
-
- :ref:`yamllint`
- https://github.com/adrienverge/yamllint

View File

@@ -0,0 +1,31 @@
yamllint
========
`yamllint <https://github.com/adrienverge/yamllint>`__ is a linter for YAML files.
Run Locally
-----------
The mozlint integration of yamllint can be run using mach:
.. parsed-literal::
$ mach lint --linter yaml <file paths>
Alternatively, omit ``--linter yaml`` to run all configured linters, including
yamllint.
Configuration
-------------
To enable yamllint on a new directory, add the path to the include section in
the :searchfox:`yaml.yml <tools/lint/yaml.yml>` file.
Sources
-------
* :searchfox:`Configuration (YAML) <tools/lint/yaml.yml>`
* :searchfox:`Source <tools/lint/yamllint_/__init__.py>`