/
prefer-function-type.ts
155 lines (144 loc) · 4.44 KB
/
prefer-function-type.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
import {
AST_NODE_TYPES,
AST_TOKEN_TYPES,
TSESTree,
} from '@typescript-eslint/util';
import * as util from '../util';
export default util.createRule({
name: 'prefer-function-type',
meta: {
docs: {
description:
'Use function types instead of interfaces with call signatures',
category: 'Best Practices',
recommended: false,
tslintName: 'callable-types',
},
fixable: 'code',
messages: {
functionTypeOverCallableType:
"{{ type }} has only a call signature - use '{{ sigSuggestion }}' instead.",
},
schema: [],
type: 'suggestion',
},
defaultOptions: [],
create(context) {
const sourceCode = context.getSourceCode();
/**
* Checks if there the interface has exactly one supertype that isn't named 'Function'
* @param node The node being checked
*/
function hasOneSupertype(node: TSESTree.TSInterfaceDeclaration): boolean {
if (!node.extends || node.extends.length === 0) {
return false;
}
if (node.extends.length !== 1) {
return true;
}
const expr = node.extends[0].expression;
return (
expr.type !== AST_NODE_TYPES.Identifier || expr.name !== 'Function'
);
}
/**
* @param parent The parent of the call signature causing the diagnostic
*/
function shouldWrapSuggestion(parent: TSESTree.Node | undefined): boolean {
if (!parent) {
return false;
}
switch (parent.type) {
case AST_NODE_TYPES.TSUnionType:
case AST_NODE_TYPES.TSIntersectionType:
case AST_NODE_TYPES.TSArrayType:
return true;
default:
return false;
}
}
/**
* @param call The call signature causing the diagnostic
* @param parent The parent of the call
* @returns The suggestion to report
*/
function renderSuggestion(
call:
| TSESTree.TSCallSignatureDeclaration
| TSESTree.TSConstructSignatureDeclaration,
parent: TSESTree.Node,
) {
const start = call.range[0];
const colonPos = call.returnType!.range[0] - start;
const text = sourceCode.getText().slice(start, call.range[1]);
let suggestion = `${text.slice(0, colonPos)} =>${text.slice(
colonPos + 1,
)}`;
if (shouldWrapSuggestion(parent.parent)) {
suggestion = `(${suggestion})`;
}
if (parent.type === AST_NODE_TYPES.TSInterfaceDeclaration) {
if (typeof parent.typeParameters !== 'undefined') {
return `type ${sourceCode
.getText()
.slice(
parent.id.range[0],
parent.typeParameters.range[1],
)} = ${suggestion}`;
}
return `type ${parent.id.name} = ${suggestion}`;
}
return suggestion.endsWith(';') ? suggestion.slice(0, -1) : suggestion;
}
/**
* @param member The TypeElement being checked
* @param node The parent of member being checked
*/
function checkMember(member: TSESTree.TypeElement, node: TSESTree.Node) {
if (
(member.type === AST_NODE_TYPES.TSCallSignatureDeclaration ||
member.type === AST_NODE_TYPES.TSConstructSignatureDeclaration) &&
typeof member.returnType !== 'undefined'
) {
const suggestion = renderSuggestion(member, node);
const fixStart =
node.type === AST_NODE_TYPES.TSTypeLiteral
? node.range[0]
: sourceCode
.getTokens(node)
.filter(
token =>
token.type === AST_TOKEN_TYPES.Keyword &&
token.value === 'interface',
)[0].range[0];
context.report({
node: member,
messageId: 'functionTypeOverCallableType',
data: {
type:
node.type === AST_NODE_TYPES.TSTypeLiteral
? 'Type literal'
: 'Interface',
sigSuggestion: suggestion,
},
fix(fixer) {
return fixer.replaceTextRange(
[fixStart, node.range[1]],
suggestion,
);
},
});
}
}
return {
TSInterfaceDeclaration(node) {
if (!hasOneSupertype(node) && node.body.body.length === 1) {
checkMember(node.body.body[0], node);
}
},
'TSTypeLiteral[members.length = 1]'(node: TSESTree.TSTypeLiteral) {
checkMember(node.members[0], node);
},
};
},
});