mirror of
https://github.com/adrienverge/yamllint.git
synced 2025-02-25 18:55:20 -06:00
A linter for YAML files.
Some unittests set environment variables, but then delete them as part of their cleanup process. Deleting them is OK. Any test that needs an environment variable should set that environment variable itself. Once the test process stops, any changes made to the environment will be lost [1]. Before this change, there was one location where an environment variable was restored to its original value instead of deleted. Restoring that variable was unnecessary. This commit was created to prepare for a future commit which will delete HOME before any of the tests even start. Without this change, that future change would crash. You can’t restore a variable that’s been deleted. Fixes #605. [1]: <https://stackoverflow.com/q/716011/7593853> |
||
---|---|---|
.github/workflows | ||
docs | ||
tests | ||
yamllint | ||
.flake8 | ||
.gitignore | ||
.pre-commit-hooks.yaml | ||
.readthedocs.yaml | ||
CHANGELOG.rst | ||
CONTRIBUTING.rst | ||
LICENSE | ||
pyproject.toml | ||
README.rst | ||
setup.py |
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://github.com/adrienverge/yamllint/actions/workflows/ci.yaml/badge.svg?branch=master :target: https://github.com/adrienverge/yamllint/actions/workflows/ci.yaml?query=branch%3Amaster :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: https://yamllint.readthedocs.io/en/latest/?badge=latest :alt: Documentation status Written in Python (compatible with Python 3 only). Documentation ------------- https://yamllint.readthedocs.io/ Overview -------- Screenshot ^^^^^^^^^^ .. image:: docs/screenshot.png :alt: yamllint screenshot Installation ^^^^^^^^^^^^ Using pip, the Python package manager: .. code:: bash pip install --user yamllint yamllint is also packaged for all major operating systems, see installation examples (``dnf``, ``apt-get``...) `in the documentation <https://yamllint.readthedocs.io/en/stable/quickstart.html>`_. 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 pre-defined lint configuration yamllint -d relaxed file.yaml # Use a custom lint configuration yamllint -c /path/to/myconfig file-to-lint.yaml .. code:: bash # Output a parsable format (for syntax checking in editors like Vim, emacs...) yamllint -f parsable file.yaml `Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__ Features ^^^^^^^^ Here is a yamllint configuration file 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 Within a YAML file, special comments can be used to disable checks for a single line: .. code:: yaml This line is waaaaaaaaaay too long # yamllint disable-line or for a whole block: .. code:: yaml # 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: .. code:: yaml # 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/* `Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__ License ------- `GPL version 3 <LICENSE>`_