Skip to content

Commit

Permalink
updating readme to support auto-formatting of ruff in pycharm
Browse files Browse the repository at this point in the history
  • Loading branch information
Vaibhav159 committed Dec 17, 2024
1 parent 204a08a commit 4208d2d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,15 @@ Install the
}
```

### PyCharm

`ruff` was installed in the `venv` environment described before, now to enable autoformatting on save, go to `File` -> `Settings` -> `Tools` -> `File Watchers` and add a new watcher with the following settings:
1. **Name**: `Ruff formatter`
2. **File type**: `Python`
3. **Working directory**: `$ContentRoot$`
4. **Arguments**: `format $FilePath$ --config pyproject.toml`
5. **Program**: `$PyInterpreterDirectory$/ruff`

## Contributing

We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help:
Expand Down

0 comments on commit 4208d2d

Please sign in to comment.