Skip to content

yamllint

GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

yamllint documentation

yamllint - GitHub

Configuration in MegaLinter

Variable Description Default value
YAML_YAMLLINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS User custom arguments to remove from command line before calling the linter
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_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project
list_of_files
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_PRE_COMMANDS List of bash commands to run before the linter None
YAML_YAMLLINT_POST_COMMANDS List of bash commands to run after the linter None
YAML_YAMLLINT_UNSECURED_ENV_VARIABLES List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands None
YAML_YAMLLINT_CONFIG_FILE yamllint configuration file nameUse LINTER_DEFAULT to let the linter find it .yamllint.yml
YAML_YAMLLINT_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
YAML_YAMLLINT_DISABLE_ERRORS Run linter but consider errors as warnings false
YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0
YAML_YAMLLINT_CLI_EXECUTABLE Override CLI executable ['yamllint']

IDE Integration

Use yamllint in your favorite IDE to catch errors before MegaLinter !

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

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 124 Docker Image Size (tag) Docker Pulls
c_cpp Optimized for pure C/C++ projects 54 Docker Image Size (tag) Docker Pulls
ci_light Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML 20 Docker Image Size (tag) Docker Pulls
cupcake MegaLinter for the most commonly used languages 83 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 50 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 62 Docker Image Size (tag) Docker Pulls
dotnetweb Optimized for C, C++, C# or VB based projects with JS/TS 71 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 52 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 53 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 60 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 55 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 63 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 51 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 51 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 55 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 51 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 55 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .yml, .yaml

How the linting is performed

  • yamllint is called once with the list of files as arguments (list_of_files CLI lint mode)

Example calls

yamllint myfile.yaml
yamllint -c .yamllint.yml myfile.yaml
yamllint --strict
yamllint --no-warnings

Help content

usage: yamllint [-h] [-] [-c CONFIG_FILE | -d CONFIG_DATA] [--list-files]
                [-f {parsable,standard,colored,github,auto}] [-s]
                [--no-warnings] [-v]
                [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

options:
  -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)
  --list-files          list files to lint and exit
  -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