|
3 | 3 | ```bash
|
4 | 4 | ❯ npx commitlint --help
|
5 | 5 |
|
6 |
| -@commitlint/cli@8.0.0 - Lint your commit messages |
| 6 | +@commitlint/cli@8.3.5 - Lint your commit messages |
7 | 7 |
|
8 | 8 | [input] reads from stdin if --edit, --env, --from and --to are omitted
|
9 |
| ---color, -c toggle colored output, defaults to: true |
10 |
| ---config, -g path to the config file |
11 |
| ---cwd, -d directory to execute in, defaults to: $CD |
12 |
| ---edit, -e read last commit message from the specified file or fallbacks to ./.git/COMMIT_EDITMSG |
13 |
| ---env, -E check message in the file at path given by environment variable value |
14 |
| ---extends, -x array of shareable configurations to extend |
15 |
| ---help, -h display this help message |
16 |
| ---from, -f lower end of the commit range to lint; applies if edit=false |
17 |
| ---format, -o output format of the results |
18 |
| ---parser-preset, -p configuration preset to use for conventional-commits-parser |
19 |
| ---quiet, -q toggle console output |
20 |
| ---to, -t upper end of the commit range to lint; applies if edit=false |
21 |
| ---version, -v display version information |
22 |
| ---verbose, -V enable verbose output for reports without problems |
| 9 | + |
| 10 | +Options: |
| 11 | + --color, -c toggle colored output [boolean] [default: true] |
| 12 | + --config, -g path to the config file [string] |
| 13 | + --cwd, -d directory to execute in |
| 14 | + [string] [default: "/projects/commitlint"] |
| 15 | + --edit, -e read last commit message from the specified file or |
| 16 | + fallbacks to ./.git/COMMIT_EDITMSG |
| 17 | + [string] [default: false] |
| 18 | + --env, -E check message in the file at path given by environment |
| 19 | + variable value [string] |
| 20 | + --extends, -x array of shareable configurations to extend [array] |
| 21 | + --help-url, -H helpurl in error message [string] |
| 22 | + --from, -f lower end of the commit range to lint; applies if |
| 23 | + edit=false [string] |
| 24 | + --format, -o output format of the results [string] |
| 25 | + --parser-preset, -p configuration preset to use for |
| 26 | + conventional-commits-parser [string] |
| 27 | + --quiet, -q toggle console output [boolean] [default: false] |
| 28 | + --to, -t upper end of the commit range to lint; applies if |
| 29 | + edit=false [string] |
| 30 | + --verbose, -V enable verbose output for reports without problems |
| 31 | + [boolean] |
| 32 | + -v, --version display version information [boolean] |
| 33 | + -h, --help Show help [boolean] |
23 | 34 | ```
|
0 commit comments