UNPKG

2.09 kBTypeScriptView Raw
1import { RuleConfigSeverity } from '@commitlint/types';
2import type { QualifiedRules } from '@commitlint/types';
3import type { RuleEntry } from './types';
4/**
5 * Get name for a given rule id
6 * @param id of the rule
7 * @return name of the rule
8 */
9export declare function getRuleName(id: string): string;
10/**
11 * Get prefix for a given rule id
12 * @param id of the rule
13 * @return prefix of the rule
14 */
15export declare function getRulePrefix(id: string): string | null;
16/**
17 * Get a predicate matching rule definitions with a given name
18 */
19export declare function getHasName(name: string): <T extends RuleEntry>(rule: RuleEntry) => rule is Exclude<T, [string, undefined]>;
20/**
21 * Check if a rule definition is active
22 * @param rule to check
23 * @return if the rule definition is active
24 */
25export declare function ruleIsActive<T extends RuleEntry>(rule: T): rule is Exclude<T, [string, Readonly<[RuleConfigSeverity.Disabled]>]>;
26/**
27 * Check if a rule definition is applicable
28 * @param rule to check
29 * @return if the rule definition is applicable
30 */
31export declare function ruleIsApplicable(rule: RuleEntry): rule is [string, Readonly<[RuleConfigSeverity, 'always']>] | [string, Readonly<[RuleConfigSeverity, 'always', unknown]>];
32/**
33 * Check if a rule definition is applicable
34 * @param rule to check
35 * @return if the rule definition is applicable
36 */
37export declare function ruleIsNotApplicable(rule: RuleEntry): rule is [string, Readonly<[RuleConfigSeverity, 'never']>] | [string, Readonly<[RuleConfigSeverity, 'never', unknown]>];
38export declare function enumRuleIsActive(rule: RuleEntry): rule is [
39 string,
40 Readonly<[
41 RuleConfigSeverity.Warning | RuleConfigSeverity.Error,
42 'always',
43 string[]
44 ]>
45];
46/**
47 * Get rules for a given prefix
48 * @param prefix to search in rule names
49 * @param rules rules to search in
50 * @return rules matching the prefix search
51 */
52export declare function getRules(prefix: string, rules: QualifiedRules): RuleEntry[];
53export declare function getMaxLength(rule?: RuleEntry): number;
54//# sourceMappingURL=utils.d.ts.map
\No newline at end of file