yamllint
v1.11.0
  • Quickstart
  • Configuration
  • Rules
  • Disable with comments
  • Development
  • Integration with text editors
  • Integration with other software
yamllint
  • Docs »
  • yamllint documentation
  • Edit on GitHub

yamllint documentation¶

A linter for YAML files.

yamllint does not only check for syntax validity, but for weirdnesses like key repetition and cosmetic problems such as lines length, trailing spaces, indentation, etc.

Screenshot¶

yamllint screenshot

Note

The default output format is inspired by eslint, a great linting tool for Javascript.

Table of contents¶

  • Quickstart
    • Installing yamllint
    • Running yamllint
  • Configuration
    • Default configuration
    • Extending the default configuration
    • Custom configuration without a config file
    • Errors and warnings
    • Ignoring paths
  • Rules
    • braces
    • brackets
    • colons
    • commas
    • comments
    • comments-indentation
    • document-end
    • document-start
    • empty-lines
    • empty-values
    • hyphens
    • indentation
    • key-duplicates
    • key-ordering
    • line-length
    • new-line-at-end-of-file
    • new-lines
    • octal-values
    • trailing-spaces
    • truthy
  • Disable with comments
    • Disabling checks for a specific line
    • Disabling checks for all (or part of) the file
  • Development
  • Integration with text editors
    • Vim
    • Neovim
    • Emacs
    • Other text editors
  • Integration with other software
    • Integration with pre-commit
Next

© Copyright Copyright 2016, Adrien Vergé Revision 6a842229.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v1.11.0
Versions
latest
stable
v1.12.0
v1.11.1
v1.11.0
v1.10.0
v1.9.0
1.8.2
1.8.1-1
v1.8.1
v1.8.0
v1.7.0
v1.6.1
v1.6.0
v1.5.0
v1.4.1
v1.4.0
v1.3.2
v1.3.1
v1.3.0
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.