NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2025-02-25 18:55:20 -06:00
Code Issues Packages Projects Releases Wiki Activity
A linter for YAML files.
74 Commits 6 Branches 69 Tags 3 MiB
Python 99.2%
Roff 0.8%
431a379c81
Go to file
Adrien Vergé 431a379c81 Tests: Add tests from YAML 1.2 specification 
Write all examples from http://www.yaml.org/spec/1.2/spec.html in
independent files in tests/yaml-1.2-spec-examples; and test them with
yamllint.
2016-02-01 17:05:22 +01:00
docs Doc: Update Vim integration documentation 2016-01-26 17:20:22 +01:00
tests Tests: Add tests from YAML 1.2 specification 2016-02-01 17:05:22 +01:00
yamllint Rules: indentation: Fix flow sequences with multi-line scalars 2016-02-01 16:56:32 +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
README.rst Doc: Enhance short description 2016-01-24 18:40:48 +01:00
setup.py Doc: Enhance short description 2016-01-24 18:40:48 +01:00

README.rst 

yamllint
========

A linter for YAML files.

yamllint does not only check for syntax validity, but for common cosmetic
conventions 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