Skip to content

Commit 012c18e

Browse files
committed
docs(rules): clarify default rule type condition
1 parent e88fb17 commit 012c18e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

@commitlint/rules/src/types.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {Commit} from '@commitlint/parse';
33
/**
44
* Rules always have a condition.
55
* It can be either "always" (as tested), or "never" (as tested).
6-
* For example, `header-full-stop` can be enforced as "always", or "never".
6+
* For example, `header-full-stop` can be enforced as "always" or "never".
77
*/
88
export type RuleCondition = 'always' | 'never';
99

@@ -16,7 +16,7 @@ export type RuleOutcome = [boolean, string?];
1616

1717
/**
1818
* Rules receive a parsed commit, condition, and possible additional settings through value.
19-
* When no rule condition is provided, it will default to `always`.
19+
* When no rule condition is provided, it should default to `always`.
2020
*/
2121
export type Rule<Value = never> = (
2222
parse: Commit,

0 commit comments

Comments
 (0)