Skip to content

ruff.md

Latest commit

 

History

History
28 lines (18 loc) · 1.11 KB

ruff.md

File metadata and controls

28 lines (18 loc) · 1.11 KB
Raw

Configure Ruff's Linter and Formatter

This documents ensures Ruff to lint and format the file on each save action.

Configure In PyCharm

  1. Install CoRA and start CoRA's environment following instructions in README.md.
  2. Install Ruff with the version (with a comment # Ruff version.) shown in pre-commit configs. For example:
pip install ruff==v0.7.2  # Change the version accordingly
  1. Import CoRA into PyCharm; please ensure CoRA's environment has been imported as a common conda environment
  2. Open Settings -> Tools -> File Watchers, and add a new file watcher named with the following configurations with the Arguments filled with
-c "$PyInterpreterDirectory$/ruff check $FilePathRelativeToProjectRoot$ && $PyInterpreterDirectory$/ruff format $FilePathRelativeToProjectRoot$"

Ruff in PyCharm

  1. Open Settings -> Tools -> Actions On Save to ensure "File Watcher: Ruff Lint & Format" is toggled.
  2. Save to apply all the above settings.

Configure in VSCode

TODO: Add instructions to configure Ruff in VSCode