/
ban-matchers.ts
91 lines (77 loc) · 2.21 KB
/
ban-matchers.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
import { createRule, isExpectCall, parseExpectCall } from './utils';
export default createRule<
[Record<string, string | null>],
'bannedChain' | 'bannedChainWithMessage'
>({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Bans specific matchers & modifiers from being used',
recommended: false,
},
type: 'suggestion',
schema: [
{
type: 'object',
additionalProperties: {
type: ['string', 'null'],
},
},
],
messages: {
bannedChain: '{{ chain }} is banned, and so should not be used',
bannedChainWithMessage: '{{ message }}',
},
},
defaultOptions: [{}],
create(context, [bannedChains]) {
return {
CallExpression(node) {
if (!isExpectCall(node)) {
return;
}
const { matcher, modifier } = parseExpectCall(node);
if (matcher) {
const chain = matcher.name;
if (chain in bannedChains) {
const message = bannedChains[chain];
context.report({
messageId: message ? 'bannedChainWithMessage' : 'bannedChain',
data: { message, chain },
node: matcher.node.property,
});
return;
}
}
if (modifier) {
const chain = modifier.name;
if (chain in bannedChains) {
const message = bannedChains[chain];
context.report({
messageId: message ? 'bannedChainWithMessage' : 'bannedChain',
data: { message, chain },
node: modifier.node.property,
});
return;
}
}
if (matcher && modifier) {
const chain = `${modifier.name}.${matcher.name}`;
if (chain in bannedChains) {
const message = bannedChains[chain];
context.report({
messageId: message ? 'bannedChainWithMessage' : 'bannedChain',
data: { message, chain },
loc: {
start: modifier.node.property.loc.start,
end: matcher.node.property.loc.end,
},
});
return;
}
}
},
};
},
});