Skip to content

docs: add result info to config option #4241 #4145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2024
Merged

docs: add result info to config option #4241 #4145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion @commitlint/cli/src/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ test('should print help', async () => {

Options:
-c, --color toggle colored output [boolean] [default: true]
-g, --config path to the config file [string]
-g, --config path to the config file; result code 9 if config is missing [string]
--print-config print resolved config [string] [choices: "", "text", "json"]
-d, --cwd directory to execute in [string] [default: (Working Directory)]
-e, --edit read last commit message from the specified file or fallbacks to ./.git/COMMIT_EDITMSG [string]
Expand Down
3 changes: 2 additions & 1 deletion @commitlint/cli/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ const cli = yargs(process.argv.slice(2))
},
config: {
alias: 'g',
description: 'path to the config file',
description:
'path to the config file; result code 9 if config is missing',
type: 'string',
},
'print-config': {
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
```sh
❯ npx commitlint --help

@commitlint/cli@19.3.0 - Lint your commit messages
@commitlint/cli@19.5.0 - Lint your commit messages

[input] reads from stdin if --edit, --env, --from and --to are omitted

Options:
-c, --color toggle colored output [boolean] [default: true]
-g, --config path to the config file [string]
-g, --config path to the config file; result code 9 if config is
missing [string]
--print-config print resolved config
[string] [choices: "", "text", "json"]
-d, --cwd directory to execute in
Expand Down