Set force-exclude in docs (#13)

This commit is contained in:
Charlie Marsh 2022-12-22 10:47:35 -05:00 committed by GitHub
parent 8873376169
commit e898edf05c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,22 +2,25 @@
A [pre-commit](https://pre-commit.com/) hook for [Ruff](https://github.com/charliermarsh/ruff). A [pre-commit](https://pre-commit.com/) hook for [Ruff](https://github.com/charliermarsh/ruff).
Distributed as a standalone repository to enable installing ruff via prebuilt wheels from Distributed as a standalone repository to enable installing Ruff via prebuilt wheels from
[PyPI](https://pypi.org/project/ruff/). [PyPI](https://pypi.org/project/ruff/).
For pre-commit: see https://github.com/pre-commit/pre-commit For pre-commit: see https://github.com/pre-commit/pre-commit
For ruff: see https://github.com/charliermarsh/ruff For Ruff: see https://github.com/charliermarsh/ruff
### Using ruff with pre-commit ### Using ruff with pre-commit
Add this to your `.pre-commit-config.yaml`: Add this to your `.pre-commit-config.yaml`:
```yaml ```yaml
- repo: https://github.com/charliermarsh/ruff-pre-commit - repo: https://github.com/charliermarsh/ruff-pre-commit
rev: '' # Use the sha / tag you want to point at # Ruff version.
hooks: rev: 'v0.0.191'
- id: ruff hooks:
- id: ruff
# Respect `exclude` and `extend-exclude` settings.
args: ["--force-exclude"]
``` ```
## License ## License