summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/yamllint.rst
blob: e148a6aacea5977973d7c57c6725e268cc1a13d2 (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
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>`