-
Notifications
You must be signed in to change notification settings - Fork 16
/
enforce-effect-naming-convention.js
134 lines (119 loc) · 3.56 KB
/
enforce-effect-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
const {
extractImportedFromEffector,
} = require("../../utils/extract-imported-from-effector");
module.exports = {
meta: {
type: "problem",
docs: {
description:
"Enforce Fx as a suffix for any effect created by Effector methods",
category: "Naming",
recommended: true,
},
messages: {
invalidName:
'Effect "{{ effectName }}" should be named with suffix, rename it to "{{ effectName }}Fx"',
renameEffect: 'Rename "{{ effectName }}" to "{{ effectName }}Fx"',
},
schema: [],
},
create(context) {
const parserServices = context.parserServices;
// TypeScript-way
if (parserServices.hasFullTypeInformation) {
return {
VariableDeclarator(node) {
const checker = parserServices.program.getTypeChecker();
const originalNode = parserServices.esTreeNodeToTSNodeMap.get(node);
const type = checker.getTypeAtLocation(originalNode.initializer);
const isEffectorEffect =
type?.symbol?.escapedName === "Effect" &&
type?.symbol?.parent?.escapedName?.includes("effector");
if (!isEffectorEffect) {
return;
}
const effectName = node.id.name;
if (effectName?.endsWith("Fx")) {
return;
}
reportEffectNameConventionViolation({ context, node, effectName });
},
};
}
// JavaScript-way
const importedFromEffector = new Map();
return {
ImportDeclaration(node) {
extractImportedFromEffector(importedFromEffector, node);
},
CallExpression(node) {
// Effect creation with method
const EFFECT_CREATION_METHODS = ["createEffect", "attach", "combine"];
for (const method of EFFECT_CREATION_METHODS) {
const localMethod = importedFromEffector.get(method);
if (!localMethod) {
continue;
}
const isEffectorEffectCreation = node.callee.name === localMethod;
if (!isEffectorEffectCreation) {
continue;
}
const resultSavedInVariable =
node.parent.type === "VariableDeclarator";
if (!resultSavedInVariable) {
continue;
}
const effectName = node.parent.id.name;
if (effectName.endsWith("Fx")) {
continue;
}
reportEffectNameConventionViolation({
context,
node: node.parent,
effectName,
});
return;
}
// Effect creation in domain
const STORE_IN_DOMAIN_CREATION_METHODS = ["createEffect", "effect"];
if (
STORE_IN_DOMAIN_CREATION_METHODS.includes(node.callee?.property?.name)
) {
const resultSavedInVariable =
node.parent.type === "VariableDeclarator";
if (!resultSavedInVariable) {
return;
}
const effectName = node.parent.id.name;
if (effectName.endsWith("Fx")) {
return;
}
reportEffectNameConventionViolation({
context,
node: node.parent,
effectName,
});
return;
}
},
};
},
};
function reportEffectNameConventionViolation({ context, node, effectName }) {
context.report({
node,
messageId: "invalidName",
data: {
effectName,
},
suggest: [
{
messageId: "renameEffect",
data: { effectName },
fix(fixer) {
return fixer.insertTextAfterRange(node.id.range, "Fx");
},
},
],
});
}