rules.rst

Rules

When linting a document with yamllint, a series of rules (such as line-length, trailing-spaces, etc.) are checked against.

A 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.

List of rules

braces

yamllint.rules.braces

brackets

yamllint.rules.brackets

colons

yamllint.rules.colons

commas

yamllint.rules.commas

comments

yamllint.rules.comments

comments-indentation

yamllint.rules.comments_indentation

document-end

yamllint.rules.document_end

document-start

yamllint.rules.document_start

empty-lines

yamllint.rules.empty_lines

empty-values

yamllint.rules.empty_values

hyphens

yamllint.rules.hyphens

indentation

yamllint.rules.indentation

key-duplicates

yamllint.rules.key_duplicates

key-ordering

yamllint.rules.key_ordering

line-length

yamllint.rules.line_length

new-line-at-end-of-file

yamllint.rules.new_line_at_end_of_file

new-lines

yamllint.rules.new_lines

octal-values

yamllint.rules.octal_values

quoted-strings

yamllint.rules.quoted_strings

trailing-spaces

yamllint.rules.trailing_spaces

truthy

yamllint.rules.truthy