-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
space-before-function-paren.ts
187 lines (172 loc) · 5.39 KB
/
space-before-function-paren.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
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type Option = 'never' | 'always';
type FuncOption = Option | 'ignore';
export type Options = [
| Option
| {
anonymous?: FuncOption;
named?: FuncOption;
asyncArrow?: FuncOption;
},
];
export type MessageIds = 'unexpected' | 'missing';
export default util.createRule<Options, MessageIds>({
name: 'space-before-function-paren',
meta: {
type: 'layout',
docs: {
description: 'Enforces consistent spacing before function parenthesis',
recommended: false,
extendsBaseRule: true,
},
fixable: 'whitespace',
schema: [
{
oneOf: [
{
enum: ['always', 'never'],
},
{
type: 'object',
properties: {
anonymous: {
enum: ['always', 'never', 'ignore'],
},
named: {
enum: ['always', 'never', 'ignore'],
},
asyncArrow: {
enum: ['always', 'never', 'ignore'],
},
},
additionalProperties: false,
},
],
},
],
messages: {
unexpected: 'Unexpected space before function parentheses.',
missing: 'Missing space before function parentheses.',
},
},
defaultOptions: ['always'],
create(context, [firstOption]) {
const sourceCode = context.getSourceCode();
const baseConfig = typeof firstOption === 'string' ? firstOption : 'always';
const overrideConfig = typeof firstOption === 'object' ? firstOption : {};
/**
* Determines whether a function has a name.
* @param {ASTNode} node The function node.
* @returns {boolean} Whether the function has a name.
*/
function isNamedFunction(
node:
| TSESTree.ArrowFunctionExpression
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression
| TSESTree.TSEmptyBodyFunctionExpression
| TSESTree.TSDeclareFunction,
): boolean {
if (node.id != null) {
return true;
}
const parent = node.parent!;
return (
parent.type === AST_NODE_TYPES.MethodDefinition ||
parent.type === AST_NODE_TYPES.TSAbstractMethodDefinition ||
(parent.type === AST_NODE_TYPES.Property &&
(parent.kind === 'get' || parent.kind === 'set' || parent.method))
);
}
/**
* Gets the config for a given function
* @param {ASTNode} node The function node
* @returns {string} "always", "never", or "ignore"
*/
function getConfigForFunction(
node:
| TSESTree.ArrowFunctionExpression
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression
| TSESTree.TSEmptyBodyFunctionExpression
| TSESTree.TSDeclareFunction,
): FuncOption {
if (node.type === AST_NODE_TYPES.ArrowFunctionExpression) {
// Always ignore non-async functions and arrow functions without parens, e.g. async foo => bar
if (
node.async &&
util.isOpeningParenToken(sourceCode.getFirstToken(node, { skip: 1 })!)
) {
return overrideConfig.asyncArrow ?? baseConfig;
}
} else if (isNamedFunction(node)) {
return overrideConfig.named ?? baseConfig;
// `generator-star-spacing` should warn anonymous generators. E.g. `function* () {}`
} else if (!node.generator) {
return overrideConfig.anonymous ?? baseConfig;
}
return 'ignore';
}
/**
* Checks the parens of a function node
* @param {ASTNode} node A function node
* @returns {void}
*/
function checkFunction(
node:
| TSESTree.ArrowFunctionExpression
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression
| TSESTree.TSEmptyBodyFunctionExpression
| TSESTree.TSDeclareFunction,
): void {
const functionConfig = getConfigForFunction(node);
if (functionConfig === 'ignore') {
return;
}
let leftToken: TSESTree.Token, rightToken: TSESTree.Token;
if (node.typeParameters) {
leftToken = sourceCode.getLastToken(node.typeParameters)!;
rightToken = sourceCode.getTokenAfter(leftToken)!;
} else {
rightToken = sourceCode.getFirstToken(node, util.isOpeningParenToken)!;
leftToken = sourceCode.getTokenBefore(rightToken)!;
}
const hasSpacing = sourceCode.isSpaceBetweenTokens(leftToken, rightToken);
if (hasSpacing && functionConfig === 'never') {
context.report({
node,
loc: {
start: leftToken.loc.end,
end: rightToken.loc.start,
},
messageId: 'unexpected',
fix: fixer =>
fixer.removeRange([leftToken.range[1], rightToken.range[0]]),
});
} else if (
!hasSpacing &&
functionConfig === 'always' &&
(!node.typeParameters || node.id)
) {
context.report({
node,
loc: rightToken.loc,
messageId: 'missing',
fix: fixer => fixer.insertTextAfter(leftToken, ' '),
});
}
}
return {
ArrowFunctionExpression: checkFunction,
FunctionDeclaration: checkFunction,
FunctionExpression: checkFunction,
TSEmptyBodyFunctionExpression: checkFunction,
TSDeclareFunction: checkFunction,
};
},
});