Skip to content
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

docs: update docs to reflect is-ignored changes #631

Merged
merged 2 commits into from
Apr 26, 2019
Merged

docs: update docs to reflect is-ignored changes #631

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43f224f
docs: update docs to reflect is-ignored changes
marionebl Apr 26, 2019
f97192a
docs: improve docs text
marionebl Apr 26, 2019
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
18 changes: 8 additions & 10 deletions docs/reference-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ type Config = {
*/
rules?: {[name: string]: Rule};
/*
* Custom list of Messages to Ignore, string values will be compiled as RegExp
* If any of the ignores functions returns true for a given message it will not be linted.
*/
ignoredMessages?: Array<string | RegExp | string => boolean>;
ignores?: ((message: string) => boolean)[];
/*
* If this is true we will not use any of the default is-ignored rules
* Wether the default ignore rules should be used
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would end here with a period too since it's a sentence (and you did that for the upper one).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also checked it with Grammarly, it's stating that it's not Wether but Whether. But I'm Dutch and have no clue about proper spelling 😄

*/
disableDefaultIgnoredMessages?: boolean;
defaultIgnores?: boolean;
}

const Configuration: Config = {
Expand All @@ -59,18 +59,16 @@ const Configuration: Config = {
'type-enum': [2, 'always', ['foo']]
},
/*
* These RegExp and functions are used to ignore messages that shouldn't be linted
* Functions used to ignore messages that shouldn't be linted.
*/
ignoredMessages: [
'^Entire Message to Ignore$',
/^(ci|github):/,
ignores: [
(commit) => commit === ''
],
/*
* If this is true then the default ignores like `Merge commit` are not ignored
* If this is false then the default ignores like `Merge commit` are not ignored
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, I would personally end with a period too.

* and will cause commitlint to fail
*/
disableDefaultIgnoredMessages: true
defaultIgnores: true
};

module.exports = Configuration;
Expand Down