mirror of
https://github.com/adrienverge/yamllint.git
synced 2024-11-26 01:20:15 -06:00
fb400dc64b
Allow disabling of a file, even if it is invalid YAML (syntax error) by including `# yamllint disable-file` in the first line.
104 lines
2.8 KiB
ReStructuredText
104 lines
2.8 KiB
ReStructuredText
Disable with comments
|
|
=====================
|
|
|
|
Disabling checks for a specific line
|
|
------------------------------------
|
|
|
|
To prevent yamllint from reporting problems for a specific line, add a
|
|
directive comment (``# yamllint disable-line ...``) on that line, or on the
|
|
line above. For instance:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# The following mapping contains the same key twice,
|
|
# but I know what I'm doing:
|
|
key: value 1
|
|
key: value 2 # yamllint disable-line rule:key-duplicates
|
|
|
|
- This line is waaaaaaaaaay too long but yamllint will not report anything about it. # yamllint disable-line rule:line-length
|
|
This line will be checked by yamllint.
|
|
|
|
or:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# The following mapping contains the same key twice,
|
|
# but I know what I'm doing:
|
|
key: value 1
|
|
# yamllint disable-line rule:key-duplicates
|
|
key: value 2
|
|
|
|
# yamllint disable-line rule:line-length
|
|
- This line is waaaaaaaaaay too long but yamllint will not report anything about it.
|
|
This line will be checked by yamllint.
|
|
|
|
It is possible, although not recommend, to disabled **all** rules for a
|
|
specific line:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# yamllint disable-line
|
|
- { all : rules ,are disabled for this line}
|
|
|
|
If you need to disable multiple rules, it is allowed to chain rules like this:
|
|
``# yamllint disable-line rule:hyphens rule:commas rule:indentation``.
|
|
|
|
Disabling checks for all (or part of) the file
|
|
----------------------------------------------
|
|
|
|
To prevent yamllint from reporting problems for the whole file, or for a block
|
|
of lines within the file, use ``# yamllint disable ...`` and ``# yamllint
|
|
enable ...`` directive comments. For instance:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# yamllint disable rule:colons
|
|
- Lorem : ipsum
|
|
dolor : sit amet,
|
|
consectetur : adipiscing elit
|
|
# yamllint enable rule:colons
|
|
|
|
- rest of the document...
|
|
|
|
It is possible, although not recommend, to disabled **all** rules:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# yamllint disable
|
|
- Lorem :
|
|
ipsum:
|
|
dolor : [ sit,amet]
|
|
- consectetur : adipiscing elit
|
|
# yamllint enable
|
|
|
|
If you need to disable multiple rules, it is allowed to chain rules like this:
|
|
``# yamllint disable rule:hyphens rule:commas rule:indentation``.
|
|
|
|
Disabling all checks for a file
|
|
-------------------------------
|
|
|
|
To prevent yamllint from reporting problems for a specific file, add the
|
|
directive comment ``# yamllint disable-file`` as the first line of the file.
|
|
For instance:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# yamllint disable-file
|
|
# The following mapping contains the same key twice, but I know what I'm doing:
|
|
key: value 1
|
|
key: value 2
|
|
|
|
- This line is waaaaaaaaaay too long but yamllint will not report anything about it.
|
|
This line will be checked by yamllint.
|
|
|
|
or:
|
|
|
|
.. code-block:: jinja
|
|
|
|
# yamllint disable-file
|
|
# This file is not valid YAML because it is a Jinja template
|
|
{% if extra_info %}
|
|
key1: value1
|
|
{% endif %}
|
|
key2: value2
|