/
adjacent-overload-signatures.ts
145 lines (130 loc) · 4.07 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
import {
TSESTree,
AST_NODE_TYPES,
} from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type RuleNode =
| TSESTree.ClassBody
| TSESTree.Program
| TSESTree.TSModuleBlock
| TSESTree.TSTypeLiteral
| TSESTree.TSInterfaceBody;
type Member = TSESTree.ClassElement | TSESTree.Statement | TSESTree.TypeElement;
export default util.createRule({
name: 'adjacent-overload-signatures',
meta: {
type: 'suggestion',
docs: {
description: 'Require that member overloads be consecutive',
category: 'Best Practices',
recommended: 'error',
},
schema: [],
messages: {
adjacentSignature: "All '{{name}}' signatures should be adjacent.",
},
},
defaultOptions: [],
create(context) {
const sourceCode = context.getSourceCode();
/**
* Gets the name of the member being processed.
* @param member the member being processed.
* @returns the name of the member or null if it's a member not relevant to the rule.
*/
function getMemberName(member: TSESTree.Node): string | null {
if (!member) {
return null;
}
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 getMemberName(member.declaration);
}
case AST_NODE_TYPES.TSDeclareFunction:
case AST_NODE_TYPES.FunctionDeclaration:
return member.id?.name ?? null;
case AST_NODE_TYPES.TSMethodSignature:
return util.getNameFromMember(member, sourceCode);
case AST_NODE_TYPES.TSCallSignatureDeclaration:
return 'call';
case AST_NODE_TYPES.TSConstructSignatureDeclaration:
return 'new';
case AST_NODE_TYPES.MethodDefinition:
return util.getNameFromMember(member, sourceCode);
}
return null;
}
interface Method {
name: string;
static: boolean;
}
function isSameMethod(method1: Method, method2: Method | null): boolean {
return (
!!method2 &&
method1.name === method2.name &&
method1.static === method2.static
);
}
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:
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 name = getMemberName(member);
if (name === null) {
lastMethod = null;
return;
}
const method = {
name,
static: 'static' in member && !!member.static,
};
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,
};
},
});