diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..13133c498d --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: +- repo: https://github.com/arichtman/ruff + rev: ft-pre-commit-hook + hooks: + - id: lint \ No newline at end of file diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml new file mode 100644 index 0000000000..e461941a28 --- /dev/null +++ b/.pre-commit-hooks.yaml @@ -0,0 +1,7 @@ +- id: lint + name: ruff lint + description: runs a ruff lint against all Python files + entry: ruff + language: python + types_or: [python] + pass_filenames: true diff --git a/README.md b/README.md index 025b00e9dc..9e731d0581 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,16 @@ You can run ruff in `--watch` mode to automatically re-run on-change: ruff path/to/code/ --watch ``` +ruff also works with [Pre-Commit](https://pre-commit.com) (requires Cargo on system): + +```yaml +repos: +- repo: https://github.com/charliermarsh/ruff + rev: # See latest release + hooks: + - id: lint +``` + ## Configuration ruff is configurable both via `pyproject.toml` and the command line.