diff --git a/docs/code-quality/index.rst b/docs/code-quality/index.rst index 4a5e67bc1da3..ac5ab8371419 100644 --- a/docs/code-quality/index.rst +++ b/docs/code-quality/index.rst @@ -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 diff --git a/docs/code-quality/lint/linters/yamllint.rst b/docs/code-quality/lint/linters/yamllint.rst new file mode 100644 index 000000000000..e148a6aacea5 --- /dev/null +++ b/docs/code-quality/lint/linters/yamllint.rst @@ -0,0 +1,31 @@ +yamllint +======== + +`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 + +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 ` file. + + +Sources +------- + +* :searchfox:`Configuration (YAML) ` +* :searchfox:`Source `