-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
RuleCreator.ts
110 lines (102 loc) · 3.05 KB
/
RuleCreator.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
import {
RuleMetaData,
RuleMetaDataDocs,
RuleListener,
RuleContext,
RuleModule,
} from '../ts-eslint/Rule';
import { applyDefault } from './applyDefault';
// we automatically add the url
type NamedCreateRuleMetaDocs = Omit<RuleMetaDataDocs, 'url'>;
type NamedCreateRuleMeta<TMessageIds extends string> = {
docs: NamedCreateRuleMetaDocs;
} & Omit<RuleMetaData<TMessageIds>, 'docs'>;
interface CreateAndOptions<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
> {
create: (
context: Readonly<RuleContext<TMessageIds, TOptions>>,
optionsWithDefault: Readonly<TOptions>,
) => TRuleListener;
defaultOptions: Readonly<TOptions>;
}
interface RuleWithMeta<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
> extends CreateAndOptions<TOptions, TMessageIds, TRuleListener> {
meta: RuleMetaData<TMessageIds>;
}
interface RuleWithMetaAndName<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
> extends CreateAndOptions<TOptions, TMessageIds, TRuleListener> {
meta: NamedCreateRuleMeta<TMessageIds>;
name: string;
}
/**
* Creates reusable function to create rules with default options and docs URLs.
*
* @param urlCreator Creates a documentation URL for a given rule name.
* @returns Function to create a rule with the docs URL format.
*/
function RuleCreator(urlCreator: (ruleName: string) => string) {
// This function will get much easier to call when this is merged https://github.com/Microsoft/TypeScript/pull/26349
// TODO - when the above PR lands; add type checking for the context.report `data` property
return function createNamedRule<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener = RuleListener,
>({
name,
meta,
...rule
}: Readonly<
RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>
>): RuleModule<TMessageIds, TOptions, TRuleListener> {
return createRule<TOptions, TMessageIds, TRuleListener>({
meta: {
...meta,
docs: {
...meta.docs,
url: urlCreator(name),
},
},
...rule,
});
};
}
/**
* Creates a well-typed TSESLint custom ESLint rule without a docs URL.
*
* @returns Well-typed TSESLint custom ESLint rule.
* @remarks It is generally better to provide a docs URL function to RuleCreator.
*/
function createRule<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener = RuleListener,
>({
create,
defaultOptions,
meta,
}: Readonly<RuleWithMeta<TOptions, TMessageIds, TRuleListener>>): RuleModule<
TMessageIds,
TOptions,
TRuleListener
> {
return {
meta,
create(
context: Readonly<RuleContext<TMessageIds, TOptions>>,
): TRuleListener {
const optionsWithDefault = applyDefault(defaultOptions, context.options);
return create(context, optionsWithDefault);
},
};
}
RuleCreator.withoutDocs = createRule;
export { RuleCreator };