Skip to content

Yamllint

Yamllint is 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 or indentation.

You can use it both with:

  • The Vim through the ALE plugin.

  • Pre-commit:

    File: .pre-commit-config.yaml

    - repo: https://github.com/adrienverge/yamllint
  rev: v1.21.0
  hooks:
    - id: yamllint

Configuration⚑

Ignore certain files⚑

It is possible to exclude specific files or directories, so that the linter doesn’t process them. They can be provided either as a list of paths, or as a bulk string.

You can either totally ignore files (they won’t be looked at):

extends: default

ignore: |
  /this/specific/file.yaml
  all/this/directory/
  *.template.yaml

# or:

ignore:
  - /this/specific/file.yaml
  - all/this/directory/
  - '*.template.yaml'

References⚑