pyscaffoldext-pre-commit-ruff

PyScaffold extension to use the Ruff Linter and Ruff Formatter in place of the Pre Commit Extension, putup --pre-commit defaults flake8 and isort.

The ruff configuration is added to pyproject.toml because ruff does not support setup.cfg. Some Ruff Linter recommended settings are commented out, for consistency with PyScaffold’s flake8 settings.

Uncomment to enable pre-commit additional hook in .pre-commit-config.yaml.

• pre-commit-hooks name-tests-test --pytest-test-first.

• Markdown Lint

• mdformat

• gitlint

• Codespell

• pyproject-fmt

Mypy settings are added to setup.cfg.

Usage

Just install this package with pip install pyscaffoldext-pre-commit-ruff and note that putup -h shows a new option --pre-commit-ruff. Use this flag to use the Ruff Linter and Ruff Formatter in place of putup --pre-commit defaults flake8 and isort.

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

uv tool install pre-commit
cd pyscaffoldext-pre-commit-ruff
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Note

This project has been set up using PyScaffold 4.6. For details and usage information on PyScaffold see https://pyscaffold.org/.