-
-
Notifications
You must be signed in to change notification settings - Fork 353
/
prefer-default-parameters.js
213 lines (176 loc) · 4.91 KB
/
prefer-default-parameters.js
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
204
205
206
207
208
209
210
211
212
213
'use strict';
const {findVariable} = require('eslint-utils');
const getDocumentationUrl = require('./utils/get-documentation-url');
const MESSAGE_ID = 'preferDefaultParameters';
const MESSAGE_ID_SUGGEST = 'preferDefaultParametersSuggest';
const assignmentSelector = [
'ExpressionStatement',
'[expression.type="AssignmentExpression"]'
].join('');
const declarationSelector = [
'VariableDeclaration',
'[declarations.0.type="VariableDeclarator"]'
].join('');
const isDefaultExpression = (left, right) =>
left &&
right &&
left.type === 'Identifier' &&
right.type === 'LogicalExpression' &&
(right.operator === '||' || right.operator === '??') &&
right.left.type === 'Identifier' &&
right.right.type === 'Literal';
const containsCallExpression = (source, node) => {
if (!node) {
return false;
}
if (node.type === 'CallExpression') {
return true;
}
for (const key of source.visitorKeys[node.type]) {
const value = node[key];
if (Array.isArray(value)) {
for (const element of value) {
if (containsCallExpression(source, element)) {
return true;
}
}
} else if (containsCallExpression(source, value)) {
return true;
}
}
return false;
};
const hasSideEffects = (source, function_, node) => {
for (const element of function_.body.body) {
if (element === node) {
break;
}
// Function call before default-assignment
if (containsCallExpression(source, element)) {
return true;
}
}
return false;
};
const hasExtraReferences = (assignment, references, left) => {
// Parameter is referenced prior to default-assignment
if (assignment && references[0].identifier !== left) {
return true;
}
// Old parameter is still referenced somewhere else
if (!assignment && references.length > 1) {
return true;
}
return false;
};
const isLastParameter = (parameters, parameter) => {
const lastParameter = parameters[parameters.length - 1];
// See 'default-param-last' rule
return parameter && parameter === lastParameter;
};
const needsParentheses = (source, function_) => {
if (function_.type !== 'ArrowFunctionExpression' || function_.params.length > 1) {
return false;
}
const [parameter] = function_.params;
const before = source.getTokenBefore(parameter);
const after = source.getTokenAfter(parameter);
return !after || !before || before.value !== '(' || after.value !== ')';
};
const fixDefaultExpression = (fixer, source, node) => {
const {line} = source.getLocFromIndex(node.range[0]);
const {column} = source.getLocFromIndex(node.range[1]);
const nodeText = source.getText(node);
const lineText = source.lines[line - 1];
const isOnlyNodeOnLine = lineText.trim() === nodeText;
const endsWithWhitespace = lineText[column] === ' ';
if (isOnlyNodeOnLine) {
return fixer.removeRange([
source.getIndexFromLoc({line, column: 0}),
source.getIndexFromLoc({line: line + 1, column: 0})
]);
}
if (endsWithWhitespace) {
return fixer.removeRange([
node.range[0],
node.range[1] + 1
]);
}
return fixer.removeRange(node.range);
};
const create = context => {
const source = context.getSourceCode();
const functionStack = [];
const checkExpression = (node, left, right, assignment) => {
const currentFunction = functionStack[functionStack.length - 1];
if (!currentFunction || !isDefaultExpression(left, right)) {
return;
}
const {name: firstId} = left;
const {
left: {name: secondId},
right: {raw: literal}
} = right;
// Parameter is reassigned to a different identifier
if (assignment && firstId !== secondId) {
return;
}
const {references} = findVariable(context.getScope(), secondId);
const {params} = currentFunction;
const parameter = params.find(parameter =>
parameter.type === 'Identifier' &&
parameter.name === secondId
);
if (
hasSideEffects(source, currentFunction, node) ||
hasExtraReferences(assignment, references, left) ||
!isLastParameter(params, parameter)
) {
return;
}
const replacement = needsParentheses(source, currentFunction) ?
`(${firstId} = ${literal})` :
`${firstId} = ${literal}`;
context.report({
node,
messageId: MESSAGE_ID,
suggest: [{
messageId: MESSAGE_ID_SUGGEST,
fix: fixer => [
fixer.replaceText(parameter, replacement),
fixDefaultExpression(fixer, source, node)
]
}]
});
};
return {
':function': node => {
functionStack.push(node);
},
':function:exit': () => {
functionStack.pop();
},
[assignmentSelector]: node => {
const {left, right} = node.expression;
checkExpression(node, left, right, true);
},
[declarationSelector]: node => {
const {id, init} = node.declarations[0];
checkExpression(node, id, init, false);
}
};
};
module.exports = {
create,
meta: {
type: 'suggestion',
docs: {
url: getDocumentationUrl(__filename)
},
fixable: 'code',
messages: {
[MESSAGE_ID]: 'Prefer default parameters over reassignment.',
[MESSAGE_ID_SUGGEST]: 'Replace reassignment with default parameter.'
}
}
};