mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-30 07:07:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add formatter TOML configuration to the README (#7762)

Browse source 
## Summary

This section is dated -- we now support configuration.
This commit is contained in:
Charlie Marsh 2023-10-02 11:07:02 -04:00 • committed by GitHub
parent bdf285225d
commit 97c092a102
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

27
crates/ruff_python_formatter/README.md
View file

@ -102,20 +102,29 @@ on-save by adding `"editor.formatOnSave": true` to your `settings.json`:
### Configuration
The Ruff formatter respects Ruff's [`line-length`](https://docs.astral.sh/ruff/settings/#line-length)
setting, which can be provided via a `pyproject.toml` or `ruff.toml` file, or on the CLI, as in:
The Ruff formatter allows configuration of [indent style](https://docs.astral.sh/ruff/settings/#format-indent-style),
[line ending](https://docs.astral.sh/ruff/settings/#format-line-ending), [quote style](https://docs.astral.sh/ruff/settings/#format-quote-style),
and [magic trailing comma behavior](https://docs.astral.sh/ruff/settings/#format-skip-magic-trailing-comma).
Like the linter, the Ruff formatter reads configuration via `pyproject.toml` or `ruff.toml` files,
as in:
```toml
[tool.ruff.format]
# Use tabs instead of 4 space indentation
indent-style = "tab"
# Prefer single quotes over double quotes
quote-style = "single"
```
The Ruff formatter also respects Ruff's [`line-length`](https://docs.astral.sh/ruff/settings/#line-length)
setting, which also can be provided via a `pyproject.toml` or `ruff.toml` file, or on the CLI, as
in:
```console
ruff format --line-length 100 /path/to/file.py
```
In future releases, the Ruff formatter will likely support configuration of:
- Quote style (single vs. double).
- Line endings (LF vs. CRLF).
- Indentation (tabs vs. spaces).
- Tab width.
### Excluding code from formatting
Ruff supports Black's `# fmt: off`, `# fmt: on`, and `# fmt: skip` pragmas, with a few caveats.