You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
91 lines
1.4 KiB
ReStructuredText
91 lines
1.4 KiB
ReStructuredText
9 years ago
|
Rules
|
||
|
|
=====
|
||
|
|
|
||
|
|
When linting a document with yamllint, a series of rules (such as
|
||
|
|
``line-length``, ``trailing-spaces``, etc.) are checked against.
|
||
|
|
|
||
|
|
A :doc:`configuration file <configuration>` can be used to enable or disable
|
||
|
|
these rules, to set their level (*error* or *warning*), but also to tweak their
|
||
|
|
options.
|
||
|
|
|
||
|
|
This page describes the rules and their options.
|
||
|
|
|
||
|
|
.. contents:: List of rules
|
||
|
|
:local:
|
||
|
|
:depth: 1
|
||
|
|
|
||
|
|
braces
|
||
|
|
------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.braces
|
||
|
|
|
||
|
|
brackets
|
||
|
|
--------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.brackets
|
||
|
|
|
||
|
|
colons
|
||
|
|
------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.colons
|
||
|
|
|
||
|
|
commas
|
||
|
|
------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.commas
|
||
|
|
|
||
|
|
comments
|
||
|
|
--------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.comments
|
||
|
|
|
||
|
|
comments-indentation
|
||
|
|
--------------------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.comments_indentation
|
||
|
|
|
||
|
|
document-end
|
||
|
|
------------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.document_end
|
||
|
|
|
||
|
|
document-start
|
||
|
|
--------------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.document_start
|
||
|
|
|
||
|
|
empty-lines
|
||
|
|
-----------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.empty_lines
|
||
|
|
|
||
|
|
hyphens
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.hyphens
|
||
|
|
|
||
|
|
indentation
|
||
|
|
-----------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.indentation
|
||
|
|
|
||
|
|
line-length
|
||
|
|
-----------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.line_length
|
||
|
|
|
||
|
|
new-line-at-end-of-file
|
||
|
|
-----------------------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.new_line_at_end_of_file
|
||
|
|
|
||
|
|
new-lines
|
||
|
|
---------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.new_lines
|
||
|
|
|
||
|
|
trailing-spaces
|
||
|
|
---------------
|
||
|
|
|
||
|
|
.. automodule:: yamllint.rules.trailing_spaces
|