Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document lint.preview and format.preview #8032

Merged
merged 6 commits into from
Oct 18, 2023
Merged

Document lint.preview and format.preview #8032

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ac3d228
Add `lint.preview` option
MichaReiser Oct 17, 2023
e7b249a
Document `lint.preview` and `format.preview`
MichaReiser Oct 18, 2023
e51c0e8
Update docs/preview.md
MichaReiser Oct 18, 2023
61c6462
Update docs/preview.md
MichaReiser Oct 18, 2023
12a92e4
Discard changes to crates/ruff_cli/src/args.rs
MichaReiser Oct 18, 2023
97643d3
Update docs/preview.md
MichaReiser Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@ Preview mode enables a collection of newer rules and fixes that are considered e
Preview mode can be enabled with the `--preview` flag on the CLI or by setting `preview = true` in your Ruff
configuration file (e.g. `pyproject.toml`).

Preview mode can be configured separately for linting and formatting (Ruff version 0.1.1 or newer). To enable preview lint rules without preview style formatting:
MichaReiser marked this conversation as resolved.
Show resolved Hide resolved

```toml
[lint]
preview = true
```

To enable preview style formatting without enabling any preview lint rules:

```toml
[format]
preview = true
```

## Using rules that are in preview

If a rule is marked as preview, it can only be selected if preview mode is enabled. For example, consider a
Expand Down