2015-09-18 20:20:48 +03:00
|
|
|
Linters
|
|
|
|
|
=======
|
|
|
|
|
|
2015-09-19 00:26:29 +03:00
|
|
|
.. index:: linters
|
2015-09-24 10:38:04 +03:00
|
|
|
|
|
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
ruff
|
2018-09-15 23:26:13 +03:00
|
|
|
------
|
2015-09-24 10:38:04 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
Ruff is a Python linter and code formatter, written in Rust.
|
|
|
|
|
It is a aggregation of flake8, pylint, pyupgrade and many more.
|
2015-09-24 10:38:04 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
Ruff comes with a linter (``ruff check``) and a formatter (``ruff format``).
|
|
|
|
|
The linter is a wrapper around flake8, pylint, and other linters,
|
|
|
|
|
and the formatter is a wrapper around black, isort, and other formatters.
|
2015-09-24 10:38:04 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
To run ruff without modifying your files: ::
|
2015-09-24 10:38:04 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
$ ruff format --diff .
|
|
|
|
|
$ ruff check .
|
2015-09-26 10:35:55 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
Ruff is capable of fixing most of the problems it encounters.
|
|
|
|
|
Be sure you commit first before running `ruff` so you can restore to a savepoint (and amend afterwards to prevent a double commit. : ::
|
2015-09-26 10:50:54 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
$ ruff format .
|
|
|
|
|
$ ruff check --fix .
|
|
|
|
|
# be careful with the --unsafe-fixes option, it can break your code
|
|
|
|
|
$ ruff check --fix --unsafe-fixes .
|
2015-09-26 10:50:54 +03:00
|
|
|
|
2024-02-06 21:56:31 +03:00
|
|
|
The config for ruff is located in pyproject.toml.
|
|
|
|
|
On of the most important option is `tool.ruff.lint.select`.
|
|
|
|
|
`select` determines which linters are run. In example, `DJ <https://docs.astral.sh/ruff/rules/#flake8-django-dj>`_ refers to flake8-django.
|
|
|
|
|
For a full list of available linters, see `https://docs.astral.sh/ruff/rules/ <https://docs.astral.sh/ruff/rules/>`_
|
