Go to file

Github Actions 36d09b6e15 Mirror: 0.0.288		2023-09-11 17:08:31 +00:00
.github	Revert adding toml and jupyter (#45 )	2023-07-10 15:03:43 -04:00
.gitignore	Initial commit	2022-09-19 20:52:36 -06:00
.pre-commit-hooks.yaml	Add check to entry (#32 )	2023-03-02 10:24:35 -05:00
.version	Mirror: 0.0.288	2023-09-11 17:08:31 +00:00
LICENSE	Initial commit	2022-09-19 20:52:36 -06:00
README.md	Bump README.md version to 0.0.287	2023-09-01 17:09:38 +00:00
setup.py	Mirror: 0.0.288	2023-09-11 17:08:31 +00:00
update_version.py	Update update_version.py	2023-06-20 16:40:23 -04:00

README.md

ruff-pre-commit

A pre-commit hook for Ruff.

Distributed as a standalone repository to enable installing Ruff via prebuilt wheels from PyPI.

Using Ruff with pre-commit

Add this to your .pre-commit-config.yaml:

- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.0.287
  hooks:
    - id: ruff

Or, to enable autofix:

- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.0.287
  hooks:
    - id: ruff
      args: [--fix, --exit-non-zero-on-fix]

To run the hook on Jupyter Notebooks too:

- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.0.287
  hooks:
    - id: ruff
      types_or: [python, pyi, jupyter]

Ruff's pre-commit hook should be placed after other formatting tools, such as Black and isort, unless you enable autofix, in which case, Ruff's pre-commit hook should run before Black, isort, and other formatting tools, as Ruff's autofix behavior can output code changes that require reformatting.

License

MIT