Skip to content

pombredanne/yamllint

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yamllint

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.

CI tests status

Code coverage status

Documentation status

Written in Python (compatible with Python 2 & 3).

Documentation

http://yamllint.readthedocs.org/

Short overview

Screenshot

yamllint screenshot

Installation

On Fedora / CentOS:

sudo dnf install yamllint

On Debian 9+ / Ubuntu 16.04+:

sudo apt-get install yamllint

On older Debian / Ubuntu versions:

sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
sudo apt-get install yamllint

Alternatively using pip, the Python package manager:

sudo pip install yamllint

Usage

# Lint one or more files
yamllint my_file.yml my_other_file.yaml ...
# Lint all YAML files in a directory
yamllint .
# Use a pre-defined lint configuration
yamllint -d relaxed file.yaml

# Use a custom lint configuration
yamllint -c /path/to/myconfig file-to-lint.yaml
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
yamllint -f parsable file.yaml

Configuration example

extends: default

rules:
  # 80 chars should be enough, but don't fail if a line is longer
  line-length:
    max: 80
    level: warning

  # don't bother me with this rule
  indentation: disable

About

A linter for YAML files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.4%
  • Roff 1.6%