Skip to content

Commit e4efb34

Browse files
armano2marionebl
authored andcommitted
chore: add missing new line in help and update CI doc
1 parent 63123de commit e4efb34

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

@commitlint/cli/src/cli.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ const cli = yargs
103103
.alias('v', 'version')
104104
.help('help')
105105
.alias('h', 'help')
106-
.usage(`${pkg.name}@${pkg.version} - ${pkg.description}`)
106+
.usage(`${pkg.name}@${pkg.version} - ${pkg.description}\n`)
107107
.usage(
108108
`[input] reads from stdin if --edit, --env, --from and --to are omitted`
109109
).argv;

docs/reference-cli.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,32 @@
33
```bash
44
❯ npx commitlint --help
55

6-
@commitlint/cli@8.0.0 - Lint your commit messages
6+
@commitlint/cli@8.3.5 - Lint your commit messages
77

88
[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]
2334
```

0 commit comments

Comments
 (0)