NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2024-11-22 07:36:25 -06:00
Code Issues Packages Projects Releases Wiki Activity
A linter for YAML files.
98 Commits 6 Branches 69 Tags 2.7 MiB
Python 99.2%
Roff 0.8%
e6dc67fd0a
Go to file
Adrien Vergé e6dc67fd0a Distribution: Add MANIFEST.in 
`yamllint/conf/*.yml` remains in `setup.py`'s `package_data` because it
needs to be installed when running `pip install .`.

`docs/*` and `tests/yaml-1.2-spec-examples/*` just need to be packaged,
they can go in the manifest.
2016-02-24 21:18:48 +01:00
docs Doc: Fix man page redundant description 2016-02-19 19:34:20 +01:00
tests Tests: unblacklist remaining spec examples 2016-02-05 11:14:37 +01:00
yamllint yamllint version 1.0.1 2016-02-19 19:39:52 +01:00
.gitignore Doc: Generate documentation with Sphinx 2016-01-22 18:20:28 +01:00
.travis.yml Tests: Remove Python 2.6 from CI tests 2016-01-24 17:39:36 +01:00
LICENSE Initial commit 2016-01-14 10:46:14 +01:00
MANIFEST.in Distribution: Add MANIFEST.in 2016-02-24 21:18:48 +01:00
README.rst Doc: Add a configuration example in README 2016-02-19 10:37:52 +01:00
setup.py Distribution: Add MANIFEST.in 2016-02-24 21:18:48 +01:00

README.rst 

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.

.. image::
   https://travis-ci.org/adrienverge/yamllint.svg?branch=master
   :target: https://travis-ci.org/adrienverge/yamllint
   :alt: CI tests status
.. image::
   https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
   :target: https://coveralls.io/github/adrienverge/yamllint?branch=master
   :alt: Code coverage status
.. image:: https://readthedocs.org/projects/yamllint/badge/?version=latest
   :target: http://yamllint.readthedocs.org/en/latest/?badge=latest
   :alt: Documentation status

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

Documentation
-------------

http://yamllint.readthedocs.org/

Short overview
--------------

Screenshot
^^^^^^^^^^

.. image:: docs/screenshot.png
   :alt: yamllint screenshot

Installation
^^^^^^^^^^^^

.. code:: bash

 sudo pip install yamllint

Usage
^^^^^

.. code:: bash

 # Lint one or more files
 yamllint my_file.yml my_other_file.yaml ...

.. code:: bash

 # Lint all YAML files in a directory
 yamllint .

.. code:: bash

 # Use a custom lint configuration
 yamllint -c ~/myconfig file.yml

.. code:: bash

 # Output a parsable format (for syntax checking in editors like Vim, emacs...)
 yamllint -f parsable file.yml

Configuration example
^^^^^^^^^^^^^^^^^^^^^

.. code:: yaml

 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