/
custom-error-definition.js
188 lines (149 loc) · 4.52 KB
/
custom-error-definition.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
'use strict';
const upperfirst = require('lodash.upperfirst');
const getDocumentationUrl = require('./utils/get-documentation-url');
const MESSAGE_ID_INVALID_EXPORT = 'invalidExport';
const nameRegexp = /^(?:[A-Z][\da-z]*)*Error$/;
const getClassName = name => upperfirst(name).replace(/(error|)$/i, 'Error');
const getConstructorMethod = className => `
constructor() {
super();
this.name = '${className}';
}
`;
const hasValidSuperClass = node => {
if (!node.superClass) {
return false;
}
let {name} = node.superClass;
if (node.superClass.type === 'MemberExpression') {
({name} = node.superClass.property);
}
return nameRegexp.test(name);
};
const isSuperExpression = node => node.type === 'ExpressionStatement' && node.expression.type === 'CallExpression' && node.expression.callee.type === 'Super';
const isAssignmentExpression = (node, name) => {
if (node.type !== 'ExpressionStatement' || node.expression.type !== 'AssignmentExpression') {
return false;
}
const lhs = node.expression.left;
if (!lhs.object || lhs.object.type !== 'ThisExpression') {
return false;
}
return lhs.property.name === name;
};
const customErrorDefinition = (context, node) => {
if (!hasValidSuperClass(node)) {
return;
}
if (node.id === null) {
return;
}
const {name} = node.id;
const className = getClassName(name);
if (name !== className) {
context.report({
node: node.id,
message: `Invalid class name, use \`${className}\`.`
});
}
const {body} = node.body;
const constructor = body.find(x => x.kind === 'constructor');
if (!constructor) {
context.report({
node,
message: 'Add a constructor to your error.',
fix: fixer => fixer.insertTextAfterRange([
node.body.start,
node.body.start + 1
], getConstructorMethod(name))
});
return;
}
const constructorBodyNode = constructor.value.body;
const constructorBody = constructorBodyNode.body;
const superExpression = constructorBody.find(isSuperExpression);
const messageExpressionIndex = constructorBody.findIndex(x => isAssignmentExpression(x, 'message'));
if (!superExpression) {
context.report({
node: constructorBodyNode,
message: 'Missing call to `super()` in constructor.'
});
} else if (messageExpressionIndex !== -1 && superExpression.expression.arguments.length === 0) {
const rhs = constructorBody[messageExpressionIndex].expression.right;
context.report({
node: superExpression,
message: 'Pass the error message to `super()`.',
fix: fixer => fixer.insertTextAfterRange([
superExpression.start,
superExpression.start + 6
], rhs.raw || rhs.name)
});
}
if (messageExpressionIndex !== -1) {
const expression = constructorBody[messageExpressionIndex];
context.report({
node: expression,
message: 'Pass the error message to `super()` instead of setting `this.message`.',
fix: fixer => fixer.removeRange([
messageExpressionIndex === 0 ? constructorBodyNode.start : constructorBody[messageExpressionIndex - 1].end,
expression.end
])
});
}
const nameExpression = constructorBody.find(x => isAssignmentExpression(x, 'name'));
if (!nameExpression || nameExpression.expression.right.value !== name) {
context.report({
node: nameExpression ? nameExpression.expression.right : constructorBodyNode,
message: `The \`name\` property should be set to \`${name}\`.`
});
}
};
const customErrorExport = (context, node) => {
if (!node.left.object || node.left.object.name !== 'exports') {
return;
}
if (!node.left.property) {
return;
}
const exportsName = node.left.property.name;
const maybeError = node.right;
if (maybeError.type !== 'ClassExpression') {
return;
}
if (!hasValidSuperClass(maybeError)) {
return;
}
if (!maybeError.id) {
return;
}
// Assume rule has already fixed the error name
const errorName = maybeError.id.name;
if (exportsName === errorName) {
return;
}
context.report({
node: node.left.property,
messageId: MESSAGE_ID_INVALID_EXPORT,
fix: fixer => fixer.replaceText(node.left.property, errorName)
});
};
const create = context => {
return {
ClassDeclaration: node => customErrorDefinition(context, node),
'AssignmentExpression[right.type="ClassExpression"]': node => customErrorDefinition(context, node.right),
'AssignmentExpression[left.type="MemberExpression"]': node => customErrorExport(context, node)
};
};
module.exports = {
create,
meta: {
type: 'problem',
docs: {
url: getDocumentationUrl(__filename)
},
fixable: 'code',
messages: {
[MESSAGE_ID_INVALID_EXPORT]: 'Exported error name should match error class'
}
}
};