/
space-infix-ops.ts
203 lines (175 loc) · 6.07 KB
/
space-infix-ops.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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
import { AST_TOKEN_TYPES, TSESTree } from '@typescript-eslint/utils';
import { getESLintCoreRule } from '../util/getESLintCoreRule';
import * as util from '../util';
const baseRule = getESLintCoreRule('space-infix-ops');
export type Options = util.InferOptionsTypeFromRule<typeof baseRule>;
export type MessageIds = util.InferMessageIdsTypeFromRule<typeof baseRule>;
const UNIONS = ['|', '&'];
export default util.createRule<Options, MessageIds>({
name: 'space-infix-ops',
meta: {
type: 'layout',
docs: {
description: 'Require spacing around infix operators',
recommended: false,
extendsBaseRule: true,
},
fixable: baseRule.meta.fixable,
hasSuggestions: baseRule.meta.hasSuggestions,
schema: baseRule.meta.schema,
messages: {
// @ts-expect-error -- we report on this messageId so we need to ensure it's there in case ESLint changes in future
missingSpace: "Operator '{{operator}}' must be spaced.",
...baseRule.meta.messages,
},
},
defaultOptions: [
{
int32Hint: false,
},
],
create(context) {
const rules = baseRule.create(context);
const sourceCode = context.getSourceCode();
const report = (
node: TSESTree.Node | TSESTree.Token,
operator: TSESTree.Token,
): void => {
context.report({
node: node,
loc: operator.loc,
messageId: 'missingSpace',
data: {
operator: operator.value,
},
fix(fixer) {
const previousToken = sourceCode.getTokenBefore(operator);
const afterToken = sourceCode.getTokenAfter(operator);
let fixString = '';
if (operator.range[0] - previousToken!.range[1] === 0) {
fixString = ' ';
}
fixString += operator.value;
if (afterToken!.range[0] - operator.range[1] === 0) {
fixString += ' ';
}
return fixer.replaceText(operator, fixString);
},
});
};
function isSpaceChar(token: TSESTree.Token): boolean {
return (
token.type === AST_TOKEN_TYPES.Punctuator &&
/^[=|?|:]$/.test(token.value)
);
}
function checkAndReportAssignmentSpace(
node: TSESTree.Node,
leftNode: TSESTree.Token,
rightNode?: TSESTree.Token | null,
): void {
if (!rightNode) {
return;
}
const operator = sourceCode.getFirstTokenBetween(
leftNode,
rightNode,
isSpaceChar,
);
const prev = sourceCode.getTokenBefore(operator!);
const next = sourceCode.getTokenAfter(operator!);
if (
!sourceCode.isSpaceBetween!(prev!, operator!) ||
!sourceCode.isSpaceBetween!(operator!, next!)
) {
report(node, operator!);
}
}
/**
* Check if it has an assignment char and report if it's faulty
* @param node The node to report
*/
function checkForEnumAssignmentSpace(node: TSESTree.TSEnumMember): void {
if (!node.initializer) {
return;
}
const leftNode = sourceCode.getTokenByRangeStart(node.id.range[0])!;
const rightNode = sourceCode.getTokenByRangeStart(
node.initializer.range[0],
)!;
checkAndReportAssignmentSpace(node, leftNode, rightNode);
}
/**
* Check if it has an assignment char and report if it's faulty
* @param node The node to report
*/
function checkForPropertyDefinitionAssignmentSpace(
node: TSESTree.PropertyDefinition,
): void {
const leftNode = sourceCode.getLastToken(
node.typeAnnotation ?? node.key,
)!;
const rightNode = node.value
? sourceCode.getTokenByRangeStart(node.value.range[0])
: undefined;
checkAndReportAssignmentSpace(node, leftNode, rightNode);
}
/**
* Check if it is missing spaces between type annotations chaining
* @param typeAnnotation TypeAnnotations list
*/
function checkForTypeAnnotationSpace(
typeAnnotation: TSESTree.TSIntersectionType | TSESTree.TSUnionType,
): void {
const types = typeAnnotation.types;
types.forEach(type => {
const skipFunctionParenthesis =
type.type === TSESTree.AST_NODE_TYPES.TSFunctionType
? util.isNotOpeningParenToken
: 0;
const operator = sourceCode.getTokenBefore(
type,
skipFunctionParenthesis,
);
if (operator != null && UNIONS.includes(operator.value)) {
const prev = sourceCode.getTokenBefore(operator);
const next = sourceCode.getTokenAfter(operator);
if (
!sourceCode.isSpaceBetween!(prev!, operator) ||
!sourceCode.isSpaceBetween!(operator, next!)
) {
report(typeAnnotation, operator);
}
}
});
}
/**
* Check if it has an assignment char and report if it's faulty
* @param node The node to report
*/
function checkForTypeAliasAssignment(
node: TSESTree.TSTypeAliasDeclaration,
): void {
const leftNode = sourceCode.getLastToken(node.typeParameters ?? node.id)!;
const rightNode = sourceCode.getFirstToken(node.typeAnnotation);
checkAndReportAssignmentSpace(node, leftNode, rightNode);
}
function checkForTypeConditional(node: TSESTree.TSConditionalType): void {
const extendsLastToken = sourceCode.getLastToken(node.extendsType)!;
const trueFirstToken = sourceCode.getFirstToken(node.trueType)!;
const trueLastToken = sourceCode.getLastToken(node.trueType)!;
const falseFirstToken = sourceCode.getFirstToken(node.falseType)!;
checkAndReportAssignmentSpace(node, extendsLastToken, trueFirstToken);
checkAndReportAssignmentSpace(node, trueLastToken, falseFirstToken);
}
return {
...rules,
TSEnumMember: checkForEnumAssignmentSpace,
PropertyDefinition: checkForPropertyDefinitionAssignmentSpace,
TSTypeAliasDeclaration: checkForTypeAliasAssignment,
TSUnionType: checkForTypeAnnotationSpace,
TSIntersectionType: checkForTypeAnnotationSpace,
TSConditionalType: checkForTypeConditional,
};
},
});