pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-03-29 10:16:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README docs

Browse source 
Added hook to hook list in README documentation
This commit is contained in:
David Paz 2022-07-17 10:49:51 +02:00
parent 912f1a5f41
commit a3aa3be552
No known key found for this signature in database
GPG key ID: 6600CC47B1C1B063
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -198,6 +198,20 @@ Trims trailing whitespace.
- By default, this hook trims all whitespace from the ends of lines.
To specify a custom set of characters to trim instead, use `args: [--chars,"<chars to trim>"]`.
#### `prepare-commit-msg`
Allows for using a jinja2 template for formatting your commit message.
You can configure this with the following commandline options:
- `-t` / `--template ` - absolute path to the template. Default implementations exist
for right away usage. Default value: absolute path to bundled `prepare_commit_msg_append.j2` file
- `-b` / `--branch` - may be specified multiple times to exclude branches
from formatting the commit message. Think of it as a black list feature.
Default value: `main, master`
- `-p` / `--pattern` - may be specified multiple times to include branches
for formatting the commit message. Think of it as a white list feature.
Default value: `(?<=feature/).*`
### Deprecated / replaced hooks
- `check-byte-order-marker`: instead use fix-byte-order-marker