Skip to content

Commit c7d82a2

Browse files
authored
Document native PyCharm Ruff integration (#327)
1 parent dfd82c7 commit c7d82a2

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -502,19 +502,17 @@ project:
502502

503503
## Ruff Integration
504504

505-
Integrate [Ruff](https://docs.astral.sh/ruff/editors/setup/#pycharm) linting and
506-
formatting into PyCharm.
505+
PyCharm natively supports [Ruff](https://docs.astral.sh/ruff/editors/setup/#pycharm) linting and
506+
formatting.
507507

508-
### Linting and Formatting
508+
1. Open Preferences or Settings | Python | Tools | Ruff
509+
- **Check**: Enable
510+
- Open **All Actions on Save...**
511+
- **Check**: Reformat Code
512+
- Files:Python
509513

510-
1. Install the [Ruff PyCharm Plugin](https://plugins.jetbrains.com/plugin/20574-ruff)
511-
2. Open Preferences or Settings | Tools | Ruff
512-
- **Check**: Run Ruff when the python file is saved
513-
- **Check**: Use Import Optimizer
514-
- **Check**: Use ruff format
515-
516-
Now, on <kbd>ctrl+s</kbd>, the current source file will be automatically formatted and imports
517-
sorted on save.
514+
Now, on <kbd>ctrl+s</kbd>, the current source file will be automatically formatted and linting
515+
errors will be shown within the editor.
518516

519517
> [!TIP]
520518
> These tools work best if you properly mark directories as excluded from the project that should

0 commit comments

Comments
 (0)