-
Notifications
You must be signed in to change notification settings - Fork 0
/
eslint-local-rules.cjs
194 lines (181 loc) · 5.26 KB
/
eslint-local-rules.cjs
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
module.exports = {
"no-svelte-store-in-api": {
meta: {
docs: {
description:
"Svelte stores should not be used in APIs since they are also utilized by workers.",
category: "Possible Errors",
recommended: false,
},
schema: [],
},
create(context) {
return {
ImportDeclaration(node) {
const filePath = context.getFilename();
const {
source: { value },
} = node;
if (filePath.includes("/api/") && value === "svelte/store") {
context.report({
node,
message:
"Importing 'svelte/store' is not allowed in API modules.",
});
}
},
};
},
},
"use-option-type-wrapper": {
meta: {
type: "suggestion",
docs: {
description: "Enforce use of Option<T> instead of T | null | undefined",
category: "Best Practices",
recommended: true,
},
messages: {
useOption:
"Use Option<{{ type }}> instead of {{ type }} | null | undefined.",
},
fixable: "code",
schema: [],
},
create: function (context) {
const checkForOptionType = (node) => {
if (
node.typeAnnotation.type === "TSUnionType" &&
node.typeAnnotation.types.length === 3 &&
node.typeAnnotation.types.some((t) => t.type === "TSNullKeyword") &&
node.typeAnnotation.types.some((t) => t.type === "TSUndefinedKeyword")
) {
const type = node.typeAnnotation.types.find(
(t) =>
t.type !== "TSNullKeyword" && t.type !== "TSUndefinedKeyword",
);
const typeText =
type.type === "TSTypeReference" &&
type.typeName &&
type.typeName.name
? type.typeName.name
: context.getSourceCode().getText(type);
if (type) {
try {
context.report({
node,
messageId: "useOption",
data: {
type: typeText,
},
fix(fixer) {
return fixer.replaceText(
node.typeAnnotation,
`Option<${typeText}>`,
);
},
});
} catch (e) {
// eslint-disable-next-line no-console
console.error(e);
// eslint-disable-next-line no-console
console.log(type);
}
}
}
};
return {
TSTypeAnnotation(node) {
checkForOptionType(node);
},
TSTypeAliasDeclaration(node) {
checkForOptionType(node);
},
};
},
},
"prefer-object-params": {
meta: {
type: "suggestion",
docs: {
description:
"Enforce passing parameters as an object when a function has more than one parameter",
category: "Best Practices",
recommended: true,
},
schema: [],
},
create(context) {
const checkForMoreThanOneParameter = (node) => {
const parent = node.parent;
const nonNullish = (element) =>
element !== undefined && element !== null;
// Check if it is a callback for looping methods
if (
nonNullish(parent) &&
parent.type === "CallExpression" &&
parent.callee.type === "MemberExpression" &&
["map", "reduce", "forEach", "filter", "sort", "replace"].includes(
parent.callee.property.name,
)
) {
return;
}
// Check if it is a callback for Array.from
if (
nonNullish(parent) &&
parent.type === "CallExpression" &&
parent.callee.type === "MemberExpression" &&
parent.callee.object.name === "Array" &&
parent.callee.property.name === "from"
) {
return;
}
// Check if it is a callback in a Promise constructor
if (
nonNullish(parent) &&
parent.type === "NewExpression" &&
parent.callee.name === "Promise"
) {
return;
}
// Check if it is a callback in JSON.stringify
if (
nonNullish(parent) &&
parent.type === "CallExpression" &&
parent.callee.type === "MemberExpression" &&
parent.callee.object.name === "JSON" &&
parent.callee.property.name === "stringify"
) {
return;
}
// Check if it is inside a class constructor
if (
nonNullish(parent) &&
parent.type === "MethodDefinition" &&
parent.kind === "constructor"
) {
return;
}
if (node.params.length > 1) {
context.report({
node,
message:
"Functions with more than one parameter should accept an object and use destructuring.",
});
}
};
return {
FunctionDeclaration(node) {
checkForMoreThanOneParameter(node);
},
FunctionExpression(node) {
checkForMoreThanOneParameter(node);
},
ArrowFunctionExpression(node) {
checkForMoreThanOneParameter(node);
},
};
},
},
};