mirror of
https://github.com/adrienverge/yamllint.git
synced 2025-02-25 18:55:20 -06:00
15eafeb80a
Using `setup.py` is deprecated and the new recommanded way is to declare a `pyproject.toml` file (see PEP 517 [^1]). This commit proposes to use setuptools to achieve that, because setuptools is already used by yamllint, is standard and referenced by the official Python packaging documentation [^2], and seems to be the most lightweight solution. An alternative could have been to use Poetry, see the dedicated pull request and discussion [^3]. For some period, the `setup.py` file will be kept (although almost empty), to allow old tools versions to keep working. Closes https://github.com/adrienverge/yamllint/issues/509. [^1]: https://peps.python.org/pep-0517/ [^2]: https://packaging.python.org/en/latest/tutorials/installing-packages/ [^3]: https://github.com/adrienverge/yamllint/pull/557
116 lines
2.7 KiB
ReStructuredText
116 lines
2.7 KiB
ReStructuredText
Quickstart
|
|
==========
|
|
|
|
Installing yamllint
|
|
-------------------
|
|
|
|
On Fedora / CentOS (note: `EPEL <https://docs.fedoraproject.org/en-US/epel/>`_ is
|
|
required on CentOS):
|
|
|
|
.. code:: bash
|
|
|
|
sudo dnf install yamllint
|
|
|
|
On Debian 8+ / Ubuntu 16.04+:
|
|
|
|
.. code:: bash
|
|
|
|
sudo apt-get install yamllint
|
|
|
|
On Mac OS 10.11+:
|
|
|
|
.. code:: bash
|
|
|
|
brew install yamllint
|
|
|
|
On FreeBSD:
|
|
|
|
.. code:: sh
|
|
|
|
pkg install py36-yamllint
|
|
|
|
On OpenBSD:
|
|
|
|
.. code:: sh
|
|
|
|
doas pkg_add py3-yamllint
|
|
|
|
Alternatively using pip, the Python package manager:
|
|
|
|
.. code:: bash
|
|
|
|
pip install --user yamllint
|
|
|
|
If you prefer installing from source, you can run, from the source directory:
|
|
|
|
.. code:: bash
|
|
|
|
python -m build
|
|
pip install --user dist/yamllint-*.tar.gz
|
|
|
|
Running yamllint
|
|
----------------
|
|
|
|
Basic usage:
|
|
|
|
.. code:: bash
|
|
|
|
yamllint file.yml other-file.yaml
|
|
|
|
You can also lint all YAML files in a whole directory:
|
|
|
|
.. code:: bash
|
|
|
|
yamllint .
|
|
|
|
Or lint a YAML stream from standard input:
|
|
|
|
.. code:: bash
|
|
|
|
echo -e 'this: is\nvalid: YAML' | yamllint -
|
|
|
|
The output will look like (colors are not displayed here):
|
|
|
|
::
|
|
|
|
file.yml
|
|
1:4 error trailing spaces (trailing-spaces)
|
|
4:4 error wrong indentation: expected 4 but found 3 (indentation)
|
|
5:4 error duplication of key "id-00042" in mapping (key-duplicates)
|
|
6:6 warning comment not indented like content (comments-indentation)
|
|
12:6 error too many spaces after hyphen (hyphens)
|
|
15:12 error too many spaces before comma (commas)
|
|
|
|
other-file.yaml
|
|
1:1 warning missing document start "---" (document-start)
|
|
6:81 error line too long (87 > 80 characters) (line-length)
|
|
10:1 error too many blank lines (4 > 2) (empty-lines)
|
|
11:4 error too many spaces inside braces (braces)
|
|
|
|
By default, the output of yamllint is colored when run from a terminal, and
|
|
pure text in other cases. Add the ``-f standard`` arguments to force
|
|
non-colored output. Use the ``-f colored`` arguments to force colored output.
|
|
|
|
Add the ``-f parsable`` arguments if you need an output format parsable by a
|
|
machine (for instance for :doc:`syntax highlighting in text editors
|
|
<text_editors>`). The output will then look like:
|
|
|
|
::
|
|
|
|
file.yml:6:2: [warning] missing starting space in comment (comments)
|
|
file.yml:57:1: [error] trailing spaces (trailing-spaces)
|
|
file.yml:60:3: [error] wrong indentation: expected 4 but found 2 (indentation)
|
|
|
|
If you have a custom linting configuration file (see :doc:`how to configure
|
|
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
|
|
option:
|
|
|
|
.. code:: bash
|
|
|
|
yamllint -c ~/myconfig file.yaml
|
|
|
|
.. note::
|
|
|
|
If you have a ``.yamllint`` file in your working directory, it will be
|
|
automatically loaded as configuration by yamllint.
|