mirror of
https://github.com/adrienverge/yamllint.git
synced 2024-11-22 07:36:25 -06:00
A linter for YAML files.
e3ebea6033
The `pyyaml` dependency is needed in `install_requires` but also in `setup_requires`, because running `setup.py` requires importing `yamllint`, which itself imports `yaml`. |
||
|---|---|---|
| bin | ||
| docs | ||
| tests | ||
| yamllint | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE | ||
| README.rst | ||
| setup.py | ||
yamllint ======== A linter for YAML files. .. 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 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