forked from typescript-eslint/typescript-eslint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
adjacent-overload-signatures.ts
180 lines (162 loc) · 5.06 KB
/
adjacent-overload-signatures.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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import type { TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import * as util from '../util';
type RuleNode =
| TSESTree.ClassBody
| TSESTree.Program
| TSESTree.TSModuleBlock
| TSESTree.TSTypeLiteral
| TSESTree.TSInterfaceBody
| TSESTree.BlockStatement;
type Member =
| TSESTree.ClassElement
| TSESTree.ProgramStatement
| TSESTree.TypeElement;
export default util.createRule({
name: 'adjacent-overload-signatures',
meta: {
type: 'suggestion',
docs: {
description: 'Require that function overload signatures be consecutive',
recommended: 'error',
},
schema: [],
messages: {
adjacentSignature: 'All {{name}} signatures should be adjacent.',
},
},
defaultOptions: [],
create(context) {
const sourceCode = context.getSourceCode();
interface Method {
name: string;
static: boolean;
callSignature: boolean;
type: util.MemberNameType;
}
/**
* Gets the name and attribute of the member being processed.
* @param member the member being processed.
* @returns the name and attribute of the member or null if it's a member not relevant to the rule.
*/
function getMemberMethod(member: TSESTree.Node): Method | null {
if (!member) {
return null;
}
const isStatic = 'static' in member && !!member.static;
switch (member.type) {
case AST_NODE_TYPES.ExportDefaultDeclaration:
case AST_NODE_TYPES.ExportNamedDeclaration: {
// export statements (e.g. export { a };)
// have no declarations, so ignore them
if (!member.declaration) {
return null;
}
return getMemberMethod(member.declaration);
}
case AST_NODE_TYPES.TSDeclareFunction:
case AST_NODE_TYPES.FunctionDeclaration: {
const name = member.id?.name ?? null;
if (name === null) {
return null;
}
return {
name,
static: isStatic,
callSignature: false,
type: util.MemberNameType.Normal,
};
}
case AST_NODE_TYPES.TSMethodSignature:
return {
...util.getNameFromMember(member, sourceCode),
static: isStatic,
callSignature: false,
};
case AST_NODE_TYPES.TSCallSignatureDeclaration:
return {
name: 'call',
static: isStatic,
callSignature: true,
type: util.MemberNameType.Normal,
};
case AST_NODE_TYPES.TSConstructSignatureDeclaration:
return {
name: 'new',
static: isStatic,
callSignature: false,
type: util.MemberNameType.Normal,
};
case AST_NODE_TYPES.MethodDefinition:
return {
...util.getNameFromMember(member, sourceCode),
static: isStatic,
callSignature: false,
};
}
return null;
}
function isSameMethod(method1: Method, method2: Method | null): boolean {
return (
!!method2 &&
method1.name === method2.name &&
method1.static === method2.static &&
method1.callSignature === method2.callSignature &&
method1.type === method2.type
);
}
function getMembers(node: RuleNode): Member[] {
switch (node.type) {
case AST_NODE_TYPES.ClassBody:
case AST_NODE_TYPES.Program:
case AST_NODE_TYPES.TSModuleBlock:
case AST_NODE_TYPES.TSInterfaceBody:
case AST_NODE_TYPES.BlockStatement:
return node.body;
case AST_NODE_TYPES.TSTypeLiteral:
return node.members;
}
}
/**
* Check the body for overload methods.
* @param {ASTNode} node the body to be inspected.
*/
function checkBodyForOverloadMethods(node: RuleNode): void {
const members = getMembers(node);
if (members) {
let lastMethod: Method | null = null;
const seenMethods: Method[] = [];
members.forEach(member => {
const method = getMemberMethod(member);
if (method === null) {
lastMethod = null;
return;
}
const index = seenMethods.findIndex(seenMethod =>
isSameMethod(method, seenMethod),
);
if (index > -1 && !isSameMethod(method, lastMethod)) {
context.report({
node: member,
messageId: 'adjacentSignature',
data: {
name: `${method.static ? 'static ' : ''}${method.name}`,
},
});
} else if (index === -1) {
seenMethods.push(method);
}
lastMethod = method;
});
}
}
return {
ClassBody: checkBodyForOverloadMethods,
Program: checkBodyForOverloadMethods,
TSModuleBlock: checkBodyForOverloadMethods,
TSTypeLiteral: checkBodyForOverloadMethods,
TSInterfaceBody: checkBodyForOverloadMethods,
BlockStatement: checkBodyForOverloadMethods,
};
},
});