A linter for YAML files.
Project description
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.
Written in Python (compatible with Python 3 only).
Documentation
Overview
Screenshot
Installation
Using pip, the Python package manager:
pip install --user yamllint
yamllint is also packaged for all major operating systems, see installation examples (dnf, apt-get…) in the documentation.
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
Features
Here is a yamllint configuration file 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
Within a YAML file, special comments can be used to disable checks for a single line:
This line is waaaaaaaaaay too long # yamllint disable-line
or for a whole block:
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable
Specific files can be ignored (totally or for some rules only) using a .gitignore-style pattern:
# For all rules
ignore: |
*.dont-lint-me.yaml
/bin/
!/bin/*.lint-me-anyway.yaml
rules:
key-duplicates:
ignore: |
generated
*.template.yaml
trailing-spaces:
ignore: |
*.ignore-trailing-spaces.yaml
/ascii-art/*
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for yamllint-1.35.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e16e504bb129ff515b37823b472750b36b6de07963bd74b307341ef5ad8bdc3 |
|
MD5 | a3f5c2c6902e01be0afe8f86f0c9121b |
|
BLAKE2b-256 | 09282abf1ec14df2d584b9e7ce3b0be458838741e6aaff7a540374ba9af83916 |