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

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
  • YAML files extensions
  • Ignoring paths
  • Setting the locale
• Rules
  • anchors
  • braces
  • brackets
  • colons
  • commas
  • comments
  • comments-indentation
  • document-end
  • document-start
  • empty-lines
  • empty-values
  • float-values
  • hyphens
  • indentation
  • key-duplicates
  • key-ordering
  • line-length
  • new-line-at-end-of-file
  • new-lines
  • octal-values
  • quoted-strings
  • trailing-spaces
  • truthy
• Disable with comments
  • Disabling checks for a specific line
  • Disabling checks for all (or part of) the file
  • Disabling all checks for a file
• Development
  • LintProblem
  • run()
• Integration with text editors
  • Vim
  • Neovim
  • Emacs
  • Visual Studio Code
  • IntelliJ
  • Other text editors
• Integration with other software
  • Integration with pre-commit
  • Integration with GitHub Actions
  • Integration with GitLab
  • Integration with Arcanist
• Character Encoding
  • Override character encoding