Skip to content

Commit 3b6ff05

Browse files
committed
docs: update with new --scope flag
1 parent 95b5e45 commit 3b6ff05

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,18 +129,19 @@ print(is_conventional("custom: this is a conventional commit", types=["custom"])
129129

130130
```shell
131131
$ conventional-pre-commit -h
132-
usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
132+
usage: conventional-pre-commit [-h] [--force-scope] [--scopes SCOPES] [--strict] [types ...] input
133133
134134
Check a git commit message for Conventional Commits formatting.
135135
136136
positional arguments:
137-
types Optional list of types to support
138-
input A file containing a git commit message
137+
types Optional list of types to support
138+
input A file containing a git commit message
139139
140140
options:
141-
-h, --help show this help message and exit
142-
--force-scope Force commit to have scope defined.
143-
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
141+
-h, --help show this help message and exit
142+
--force-scope Force commit to have scope defined.
143+
--scopes SCOPES Optional list of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client)
144+
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
144145
```
145146

146147
Supply arguments on the command-line, or via the pre-commit `hooks.args` property:

0 commit comments

Comments
 (0)