-
Notifications
You must be signed in to change notification settings - Fork 16
/
enforce-store-naming-convention.js
188 lines (163 loc) · 5 KB
/
enforce-store-naming-convention.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
const {
extractImportedFromEffector,
} = require("../../utils/extract-imported-from-effector");
const { isStoreNameValid } = require("../../utils/naming");
const {
validateStoreNameConvention,
} = require("../../utils/validate-store-name-convention");
const {
getStoreNameConvention,
} = require("../../utils/get-store-name-convention");
const {
getCorrectedStoreName,
} = require("../../utils/get-corrected-store-name");
const { createLinkToRule } = require("../../utils/create-link-to-rule");
const { variableHasEffectorType } = require("../../utils/has-effector-type");
module.exports = {
meta: {
type: "problem",
docs: {
description:
"Enforce $ as a prefix or postfix for any store created by Effector methods",
category: "Naming",
recommended: true,
url: createLinkToRule("enforce-store-naming-convention"),
},
messages: {
invalidName:
'Store "{{ storeName }}" should be named with {{ storeNameConvention }}, rename it to "{{ correctedStoreName }}"',
renameStore: 'Rename "{{ storeName }}" to "{{ correctedStoreName }}"',
},
schema: [],
hasSuggestions: true,
},
create(context) {
const { parserServices } = context;
validateStoreNameConvention(context);
// TypeScript-way
if (parserServices.hasFullTypeInformation) {
return {
VariableDeclarator(node) {
const isEffectorStore = variableHasEffectorType({
node,
context,
possibleTypes: ["Store"],
});
if (!isEffectorStore) {
return;
}
const storeName = node.id.name;
if (isStoreNameValid({ name: storeName, context })) {
return;
}
reportStoreNameConventionViolation({
context,
node,
storeName,
});
},
};
}
// JavaScript-way
const importedFromEffector = new Map();
return {
ImportDeclaration(node) {
extractImportedFromEffector(importedFromEffector, node);
},
CallExpression(node) {
// Store creation with method
const STORE_CREATION_METHODS = ["createStore", "restore", "combine"];
for (const method of STORE_CREATION_METHODS) {
const localMethod = importedFromEffector.get(method);
if (!localMethod) {
continue;
}
const isEffectorStoreCreation = node.callee.name === localMethod;
if (!isEffectorStoreCreation) {
continue;
}
const resultSavedInVariable =
node.parent.type === "VariableDeclarator";
if (!resultSavedInVariable) {
continue;
}
const storeName = node.parent.id.name;
if (isStoreNameValid({ name: storeName, context })) {
continue;
}
reportStoreNameConventionViolation({
context,
node: node.parent,
storeName,
});
return;
}
// Store creation with .map
if (node.callee?.property?.name === "map") {
const storeNameCreatedFromMap = node.callee?.object?.name;
if (!isStoreNameValid({ name: storeNameCreatedFromMap, context })) {
return;
}
const resultSavedInVariable =
node.parent.type === "VariableDeclarator";
if (!resultSavedInVariable) {
return;
}
const storeName = node.parent.id.name;
if (isStoreNameValid({ name: storeName, context })) {
return;
}
reportStoreNameConventionViolation({
context,
node: node.parent,
storeName,
});
return;
}
// Store creation in domain
const STORE_IN_DOMAIN_CREATION_METHODS = ["createStore", "store"];
if (
STORE_IN_DOMAIN_CREATION_METHODS.includes(node.callee?.property?.name)
) {
const resultSavedInVariable =
node.parent.type === "VariableDeclarator";
if (!resultSavedInVariable) {
return;
}
const storeName = node.parent.id.name;
if (isStoreNameValid({ name: storeName, context })) {
return;
}
reportStoreNameConventionViolation({
context,
node: node.parent,
storeName,
});
return;
}
},
};
},
};
function reportStoreNameConventionViolation({ context, node, storeName }) {
const storeNameConvention = getStoreNameConvention(context);
const correctedStoreName = getCorrectedStoreName(storeName, context);
context.report({
node,
messageId: "invalidName",
data: {
storeName,
correctedStoreName,
storeNameConvention,
},
suggest: [
{
messageId: "renameStore",
data: { storeName, correctedStoreName },
fix(fixer) {
return fixer.replaceTextRange(node.id.range, correctedStoreName);
},
},
],
});
}