Tools¶
Pre-commit hook¶
woke supports being run from a pre-commit hook,
allowing you to avoid accidentally committing uses of non-inclusive
language.
You have two alternative mechanisms for doing so.
If you have arranged to install woke on your command search path (as well
as anyone working on your repository), then add this configuration to your
.pre-commit-config.yaml:
- repo: https://github.com/get-woke/woke
rev: '' # pick a tag to point to
hooks:
- woke
(Note that in this case the rev only controls the version of a wrapper
script that is used, not the version of woke itself.)
Alternatively, you can tell pre-commit to build woke from source,
although this requires you and anyone working on your repository to have
go on your command search path and for it to be at least version 1.18:
- repo: https://github.com/get-woke/woke
rev: '' # pick a tag to point to
hooks:
- woke-from-source
(In this case the rev controls the version of woke itself.)
See the pre-commit documentation for how to customize this further.