mirror of
https://github.com/adrienverge/yamllint.git
synced 2024-11-26 01:20:15 -06:00
A linter for YAML files.
96465008ab
YAML content like the following one produced an error, because the
multi-line ScalarToken ends at the beginning of the 4th line (the one
with the value):
? >
multi-line
key
: value
|
||
|---|---|---|
| bin | ||
| tests | ||
| yamllint | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE | ||
| README.md | ||
| setup.py | ||
yamllint
A linter for YAML files.
Compatible with Python 2 & 3.
Usage
yamllint my_file.yml my_other_file.yaml ...
yamllint -c ~/myconfig my_file.yml
# To output a format parsable (by editors like Vim, emacs, etc.)
yamllint -f parsable my_file.yml
Installation
pip install yamllint
Configuration
There is no documentation yet, so here is what you need to know: you can
override some rules, disable them or pass them in warning (instead of
error). Have a look at the content of yamllint/conf/default.yml and create
your own configuration file.
It could look like this:
# This is my first, very own configuration file for yamllint!
# It extends the default conf by adjusting some options.
extends: default
rules:
# 80 should be enough, but don't fail if a line is longer
line-length:
max: 80
level: warning
# accept both
# key:
# - item
# and
# key:
# - item
indentation:
indent-sequences: whatever
# don't bother me with this rule
comments-indentation: disable
Tip: if you have a .yamllint file in your working directory, it will be
automatically loaded as configuration by yamllint.