mirror of
https://github.com/astral-sh/ruff
synced 2026-01-09 15:44:22 -05:00
f6d6200aae
## Summary
This PR updates our documentation for the upcoming formatter release.
Broadly, the documentation is now structured as follows:
- Overview
- Tutorial
- Installing Ruff
- The Ruff Linter
- Overview
- `ruff check`
- Rule selection
- Error suppression
- Exit codes
- The Ruff Formatter
- Overview
- `ruff format`
- Philosophy
- Configuration
- Format suppression
- Exit codes
- Black compatibility
- Known deviations
- Configuring Ruff
- pyproject.toml
- File discovery
- Configuration discovery
- CLI
- Shell autocompletion
- Preview
- Rules
- Settings
- Integrations
- `pre-commit`
- VS Code
- LSP
- PyCharm
- GitHub Actions
- FAQ
- Contributing
The major changes include:
- Removing the "Usage" section from the docs, and instead folding that
information into "Integrations" and the new Linter and Formatter
sections.
- Breaking up "Configuration" into "Configuring Ruff" (for generic
configuration), and new Linter- and Formatter-specific sections.
- Updating all example configurations to use `[tool.ruff.lint]` and
`[tool.ruff.format]`.
My suggestion is to pull and build the docs locally, and review by
reading them in the browser rather than trying to parse all the code
changes.
Closes https://github.com/astral-sh/ruff/issues/7235.
Closes https://github.com/astral-sh/ruff/issues/7647.
1.1 KiB
1.1 KiB
Installing Ruff
Ruff is available as ruff on PyPI:
pip install ruff
Once installed, you can run Ruff from the command line:
ruff check . # Lint all files in the current directory.
ruff format . # Format all files in the current directory.
For macOS Homebrew and Linuxbrew users, Ruff is also available as ruff
on Homebrew:
brew install ruff
For Conda users, Ruff is also available as ruff on
conda-forge:
conda install -c conda-forge ruff
For Arch Linux users, Ruff is also available as ruff
on the official repositories:
pacman -S ruff
For Alpine users, Ruff is also available as ruff
on the testing repositories:
apk add ruff
