mirror of
https://github.com/crate-ci/typos.git
synced 2026-11-17 03:10:07 +01:00
feat: Add pre-commit integration
This commit is contained in:
1 parent
b329b17e96
commit
9739865559
3 files changed
+30
No files matched your search
@@ -0,0 +1,21 @@
|
||||
# pre-commit
|
||||
|
||||
To use `typos` with [`pre-commit`](https://pre-commit.com), point its
|
||||
config at this repository:
|
||||
|
||||
```yaml
|
||||
repos:
|
||||
- repo: https://github.com/crate-ci/typos
|
||||
rev: v1.0.6
|
||||
hooks:
|
||||
- id: typos
|
||||
```
|
||||
|
||||
Be sure to change `rev` to use the desired `typos` git tag or
|
||||
revision.
|
||||
|
||||
The hook configuration defaults to writing fixes, which triggers a
|
||||
`pre-commit` failure if any files are modified. To make it report its
|
||||
findings only instead, override the hook's `args` with something that
|
||||
does not contain `-w`/`--write-changes`, for example `[]` (meaning
|
||||
pass no options).
|
||||
Reference in new issue
Block a user