summaryrefslogtreecommitdiffstats
path: root/docs/rules.rst
blob: eb3bc821a645d9d72fe91c25a8d104a2b7abc1ff (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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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

anchors
-------

.. automodule:: yamllint.rules.anchors

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

empty-values
------------

.. automodule:: yamllint.rules.empty_values

float-values
------------

.. automodule:: yamllint.rules.float_values


hyphens
-------

.. automodule:: yamllint.rules.hyphens

indentation
-----------

.. automodule:: yamllint.rules.indentation

key-duplicates
--------------

.. automodule:: yamllint.rules.key_duplicates

key-ordering
--------------

.. automodule:: yamllint.rules.key_ordering

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

octal-values
------------

.. automodule:: yamllint.rules.octal_values

quoted-strings
--------------

.. automodule:: yamllint.rules.quoted_strings

trailing-spaces
---------------

.. automodule:: yamllint.rules.trailing_spaces

truthy
---------------

.. automodule:: yamllint.rules.truthy