Skip to content

Document native PyCharm Ruff integration #327

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

Merged
johnthagen merged 1 commit into from
Dec 13, 2025
Merged

Document native PyCharm Ruff integration #327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,19 +502,17 @@ project:

## Ruff Integration

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

### Linting and Formatting
1. Open Preferences or Settings | Python | Tools | Ruff
- **Check**: Enable
- Open **All Actions on Save...**
- **Check**: Reformat Code
- Files:Python

1. Install the [Ruff PyCharm Plugin](https://plugins.jetbrains.com/plugin/20574-ruff)
2. Open Preferences or Settings | Tools | Ruff
- **Check**: Run Ruff when the python file is saved
- **Check**: Use Import Optimizer
- **Check**: Use ruff format

Now, on <kbd>ctrl+s</kbd>, the current source file will be automatically formatted and imports
sorted on save.
Now, on <kbd>ctrl+s</kbd>, the current source file will be automatically formatted and linting
errors will be shown within the editor.

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