John Lancaster
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# Ruff Source Documentation
|
|
|
|
Use this reference when implementing or tuning Ruff in repositories.
|
|
|
|
## Core Docs
|
|
|
|
- [Ruff overview](https://docs.astral.sh/ruff/)
|
|
- [Rules reference](https://docs.astral.sh/ruff/rules/)
|
|
- [Settings reference](https://docs.astral.sh/ruff/settings/)
|
|
- [Formatter docs](https://docs.astral.sh/ruff/formatter/)
|
|
- [The Ruff linter](https://docs.astral.sh/ruff/linter/)
|
|
|
|
## Migration And Integration
|
|
|
|
- [Migrating from Black](https://docs.astral.sh/ruff/formatter/#migrating-from-black)
|
|
- [Migrating from Flake8](https://docs.astral.sh/ruff/linter/#migrating-from-flake8)
|
|
- [Migrating from isort](https://docs.astral.sh/ruff/formatter/#sorting-imports)
|
|
- [Pre-commit integration](https://docs.astral.sh/ruff/integrations/#pre-commit)
|
|
- [GitHub Actions integration](https://docs.astral.sh/ruff/integrations/#github-actions)
|
|
|
|
## Python Packaging Context
|
|
|
|
- [PEP 621 project metadata in pyproject.toml](https://peps.python.org/pep-0621/)
|
|
- [uv project and workflow docs](https://docs.astral.sh/uv/)
|
|
|
|
## Suggested Reading Order
|
|
|
|
1. Overview and settings.
|
|
2. Rules and linter behavior.
|
|
3. Formatter and migration references.
|
|
4. CI and pre-commit integration notes. |