Skip to content

Commit 650bb44

Browse files
committed
docs: document new flags
1 parent 36f7431 commit 650bb44

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

Diff for: @commitlint/cli/src/cli.js

+5
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ const flags = {
8989
alias: 'v',
9090
type: 'boolean',
9191
description: 'display version information'
92+
},
93+
verbose: {
94+
alias: 'V',
95+
type: 'boolean',
96+
description: 'enable verbose output for reports without problems'
9297
}
9398
};
9499

Diff for: docs/reference-api.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,30 @@ type ReportResult = {
4040
}
4141

4242
type formatOptions = {
43-
/*
43+
/**
4444
* Color the output
45-
*/
45+
**/
4646
color: boolean = true;
47+
48+
/**
49+
* Signs to use as decoration for messages with severy 0, 1, 2
50+
**/
51+
signs: readonly [string; string; string] = [' ', '', ''];
52+
53+
/**
54+
* Colors to use for messages with severy 0, 1, 2
55+
**/
56+
colors: readonly [string; string; string] = ['white', 'yellow', 'red'];
57+
58+
/**
59+
* Print summary and inputs for reports without problems
60+
**/
61+
verbose: boolean = false;
62+
63+
/**
64+
* URL to print as help for reports with problems
65+
**/
66+
helpUrl: string;
4767
}
4868

4969
format(report?: Report = {}, options?: formatOptions = {}) => string[];

Diff for: docs/reference-cli.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@
1818
--parser-preset, -p configuration preset to use for conventional-commits-parser
1919
--quiet, -q toggle console output
2020
--to, -t upper end of the commit range to lint; applies if edit=false
21-
--version, -v display version information
21+
--version, -v display version informationv
22+
--verbose, -V print summary and inputs for reports without problems
2223
```

0 commit comments

Comments
 (0)