Skip to content

Commit 88c018f

Browse files
authored
docs: update docs to reflect is-ignored changes (#631)
* docs: update docs to reflect is-ignored changes * docs: improve docs text
1 parent 9abbfc3 commit 88c018f

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/reference-configuration.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ type Config = {
2727
*/
2828
rules?: {[name: string]: Rule};
2929
/*
30-
* Custom list of Messages to Ignore, string values will be compiled as RegExp
30+
* Functions that return true if commitlint should ignore the given message.
3131
*/
32-
ignoredMessages?: Array<string | RegExp | string => boolean>;
32+
ignores?: ((message: string) => boolean)[];
3333
/*
34-
* If this is true we will not use any of the default is-ignored rules
34+
* Whether commitlint uses the default ignore rules.
3535
*/
36-
disableDefaultIgnoredMessages?: boolean;
36+
defaultIgnores?: boolean;
3737
}
3838

3939
const Configuration: Config = {
@@ -59,18 +59,15 @@ const Configuration: Config = {
5959
'type-enum': [2, 'always', ['foo']]
6060
},
6161
/*
62-
* These RegExp and functions are used to ignore messages that shouldn't be linted
62+
* Functions that return true if commitlint should ignore the given message.
6363
*/
64-
ignoredMessages: [
65-
'^Entire Message to Ignore$',
66-
/^(ci|github):/,
64+
ignores: [
6765
(commit) => commit === ''
6866
],
6967
/*
70-
* If this is true then the default ignores like `Merge commit` are not ignored
71-
* and will cause commitlint to fail
68+
* Whether commitlint uses the default ignore rules.
7269
*/
73-
disableDefaultIgnoredMessages: true
70+
defaultIgnores: true
7471
};
7572

7673
module.exports = Configuration;

0 commit comments

Comments
 (0)