Skip to content

yamllint

yamllint documentation

yamllint - GitHub

Configuration in Mega-Linter

Variable Description Default value
YAML_YAMLLINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
YAML_YAMLLINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src|lib)
Include every file
YAML_YAMLLINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test|examples)
Exclude no file
YAML_YAMLLINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".yml", ".yaml"]
YAML_YAMLLINT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
YAML_YAMLLINT_CONFIG_FILE yamllint configuration file name
Use LINTER_DEFAULT to let the linter find it
.yaml-lint.yml
YAML_YAMLLINT_RULES_PATH Path where to find linter configuration file Workspace folder, then Mega-Linter default rules
YAML_YAMLLINT_DISABLE_ERRORS Run linter but consider errors as warnings false

IDE Integration

Use yamllint in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Emacs flycheck Visit Web Site
vim ale Visit Web Site

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 83 Docker Image Size (tag) Docker Pulls
ci_light Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML 11 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 37 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 36 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 42 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 38 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 37 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 45 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 40 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 43 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 37 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 37 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 37 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 37 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 37 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 39 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .yml, .yaml

Example calls

yamllint myfile.yaml
yamllint -c .yaml-lint.yml myfile.yaml

Help content

usage: yamllint [-h] [-] [-c CONFIG_FILE | -d CONFIG_DATA]
                [-f {parsable,standard,colored,github,auto}] [-s]
                [--no-warnings] [-v]
                [FILE_OR_DIR [FILE_OR_DIR ...]]

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.

positional arguments:
  FILE_OR_DIR           files to check

optional arguments:
  -h, --help            show this help message and exit
  -                     read from standard input
  -c CONFIG_FILE, --config-file CONFIG_FILE
                        path to a custom configuration
  -d CONFIG_DATA, --config-data CONFIG_DATA
                        custom configuration (as YAML source)
  -f {parsable,standard,colored,github,auto}, --format {parsable,standard,colored,github,auto}
                        format for parsing output
  -s, --strict          return non-zero exit code on warnings as well as
                        errors
  --no-warnings         output only error level problems
  -v, --version         show program's version number and exit

Installation on mega-linter Docker image

Example success log

Results of yamllint linter (version 1.25.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/yaml_yamllint/
-----------------------------------------------

[SUCCESS] .automation/test/yaml/yml_good_1.yml


Example error log

Results of yamllint linter (version 1.25.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/yaml_yamllint/
-----------------------------------------------

[ERROR] .automation/test/yaml/yml_bad_1.yml
    .automation/test/yaml/yml_bad_1.yml
      10:1      warning  missing document start "---"  (document-start)
      11:16     error    syntax error: mapping values are not allowed here (syntax)