mirror of
https://github.com/adrienverge/yamllint.git
synced 2025-02-25 18:55:20 -06:00
A linter for YAML files.
dbbecb5875
Currently importing yamllint recursively imports its submodules, which finally requires having pyyaml installed. This is a problem when you just want to import APP_VERSION from yamllint. For instance, setup.py imports yamllint to know the version, but doesn't know yet that pyyaml is to be installed, because it is stated in setup.py itself. To solve this, yamllint/__init__.py will only contain constants. The linting functions will be in yamllint/linter.py. |
||
|---|---|---|
| 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