We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent e88fb17 commit 012c18eCopy full SHA for 012c18e
@commitlint/rules/src/types.ts
@@ -3,7 +3,7 @@ import {Commit} from '@commitlint/parse';
3
/**
4
* Rules always have a condition.
5
* It can be either "always" (as tested), or "never" (as tested).
6
- * For example, `header-full-stop` can be enforced as "always", or "never".
+ * For example, `header-full-stop` can be enforced as "always" or "never".
7
*/
8
export type RuleCondition = 'always' | 'never';
9
@@ -16,7 +16,7 @@ export type RuleOutcome = [boolean, string?];
16
17
18
* Rules receive a parsed commit, condition, and possible additional settings through value.
19
- * When no rule condition is provided, it will default to `always`.
+ * When no rule condition is provided, it should default to `always`.
20
21
export type Rule<Value = never> = (
22
parse: Commit,
0 commit comments