@thethracian/oxlint-config 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +153 -1
- package/dist/rules/effect-default.d.ts +19 -0
- package/dist/rules/effect-default.d.ts.map +1 -1
- package/dist/rules/effect-default.js +29 -0
- package/dist/rules/effect-default.js.map +1 -1
- package/dist/rules/effect-imported-call-matcher.d.ts.map +1 -1
- package/dist/rules/effect-imported-call-matcher.js +7 -11
- package/dist/rules/effect-imported-call-matcher.js.map +1 -1
- package/dist/rules/effect-prefer-all-discard.d.ts +5 -0
- package/dist/rules/effect-prefer-all-discard.d.ts.map +1 -0
- package/dist/rules/effect-prefer-all-discard.js +212 -0
- package/dist/rules/effect-prefer-all-discard.js.map +1 -0
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.d.ts +4 -0
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.d.ts.map +1 -0
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.js +104 -0
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.js.map +1 -0
- package/dist/rules/effect-prefer-as-over-map-constant.d.ts +4 -0
- package/dist/rules/effect-prefer-as-over-map-constant.d.ts.map +1 -0
- package/dist/rules/effect-prefer-as-over-map-constant.js +169 -0
- package/dist/rules/effect-prefer-as-over-map-constant.js.map +1 -0
- package/dist/rules/effect-prefer-as-some.d.ts +4 -0
- package/dist/rules/effect-prefer-as-some.d.ts.map +1 -0
- package/dist/rules/effect-prefer-as-some.js +255 -0
- package/dist/rules/effect-prefer-as-some.js.map +1 -0
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.d.ts +4 -0
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.d.ts.map +1 -0
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.js +204 -0
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.js.map +1 -0
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.d.ts +5 -0
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.d.ts.map +1 -0
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.js +337 -0
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.js.map +1 -0
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.d.ts +4 -0
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.d.ts.map +1 -0
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.js +275 -0
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.js.map +1 -0
- package/dist/rules/effect-prefer-foreach-discard.d.ts +4 -0
- package/dist/rules/effect-prefer-foreach-discard.d.ts.map +1 -0
- package/dist/rules/effect-prefer-foreach-discard.js +237 -0
- package/dist/rules/effect-prefer-foreach-discard.js.map +1 -0
- package/dist/rules/effect-prefer-layer-sync.d.ts +5 -0
- package/dist/rules/effect-prefer-layer-sync.d.ts.map +1 -0
- package/dist/rules/effect-prefer-layer-sync.js +183 -0
- package/dist/rules/effect-prefer-layer-sync.js.map +1 -0
- package/dist/rules/effect-prefer-map-both.d.ts +4 -0
- package/dist/rules/effect-prefer-map-both.d.ts.map +1 -0
- package/dist/rules/effect-prefer-map-both.js +175 -0
- package/dist/rules/effect-prefer-map-both.js.map +1 -0
- package/dist/rules/effect-prefer-option-get-or-else.d.ts +5 -0
- package/dist/rules/effect-prefer-option-get-or-else.d.ts.map +1 -0
- package/dist/rules/effect-prefer-option-get-or-else.js +186 -0
- package/dist/rules/effect-prefer-option-get-or-else.js.map +1 -0
- package/dist/rules/effect-prefer-option-nullish-getters.d.ts +5 -0
- package/dist/rules/effect-prefer-option-nullish-getters.d.ts.map +1 -0
- package/dist/rules/effect-prefer-option-nullish-getters.js +304 -0
- package/dist/rules/effect-prefer-option-nullish-getters.js.map +1 -0
- package/dist/rules/effect-prefer-option-or-else-some.d.ts +5 -0
- package/dist/rules/effect-prefer-option-or-else-some.d.ts.map +1 -0
- package/dist/rules/effect-prefer-option-or-else-some.js +158 -0
- package/dist/rules/effect-prefer-option-or-else-some.js.map +1 -0
- package/dist/rules/effect-prefer-ref-get-and-update.d.ts +5 -0
- package/dist/rules/effect-prefer-ref-get-and-update.d.ts.map +1 -0
- package/dist/rules/effect-prefer-ref-get-and-update.js +185 -0
- package/dist/rules/effect-prefer-ref-get-and-update.js.map +1 -0
- package/dist/rules/effect-prefer-succeed-none.d.ts +4 -0
- package/dist/rules/effect-prefer-succeed-none.d.ts.map +1 -0
- package/dist/rules/effect-prefer-succeed-none.js +107 -0
- package/dist/rules/effect-prefer-succeed-none.js.map +1 -0
- package/dist/rules/effect-prefer-succeed-some.d.ts +4 -0
- package/dist/rules/effect-prefer-succeed-some.d.ts.map +1 -0
- package/dist/rules/effect-prefer-succeed-some.js +117 -0
- package/dist/rules/effect-prefer-succeed-some.js.map +1 -0
- package/dist/rules/effect-prefer-tap-over-flatmap-as.d.ts +4 -0
- package/dist/rules/effect-prefer-tap-over-flatmap-as.d.ts.map +1 -0
- package/dist/rules/effect-prefer-tap-over-flatmap-as.js +194 -0
- package/dist/rules/effect-prefer-tap-over-flatmap-as.js.map +1 -0
- package/dist/rules/effect-prefer-yieldable-error-over-fail.d.ts +5 -0
- package/dist/rules/effect-prefer-yieldable-error-over-fail.d.ts.map +1 -0
- package/dist/rules/effect-prefer-yieldable-error-over-fail.js +348 -0
- package/dist/rules/effect-prefer-yieldable-error-over-fail.js.map +1 -0
- package/dist/rules/effect-rule-names.d.ts.map +1 -1
- package/dist/rules/effect-rule-names.js +1 -1
- package/dist/rules/effect-rule-names.js.map +1 -1
- package/dist/rules/effect-schema-no-redundant-tag-identifier.d.ts +5 -0
- package/dist/rules/effect-schema-no-redundant-tag-identifier.d.ts.map +1 -0
- package/dist/rules/effect-schema-no-redundant-tag-identifier.js +112 -0
- package/dist/rules/effect-schema-no-redundant-tag-identifier.js.map +1 -0
- package/dist/rules/effect-yieldable-schema-superclass.d.ts +12 -0
- package/dist/rules/effect-yieldable-schema-superclass.d.ts.map +1 -0
- package/dist/rules/effect-yieldable-schema-superclass.js +73 -0
- package/dist/rules/effect-yieldable-schema-superclass.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
/* -------------------------------------------------------------------------- */
|
|
2
|
+
/* Prefer Option.orElseSome when a fallback always returns Some. */
|
|
3
|
+
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { asNode, childNode, childNodes, identifierName } from './effect-ast.js';
|
|
5
|
+
import { diagnosticMessage } from './diagnostic-guidance.js';
|
|
6
|
+
import { importedEffectCallMatcher } from './effect-imported-call-matcher.js';
|
|
7
|
+
import { readCachedSource } from './source-cache.js';
|
|
8
|
+
import { strictPathOptionsSchema } from './effect-path-options.js';
|
|
9
|
+
export { default as preferOptionGetOrElseRule, preferAllDiscardRule, preferCollectionDiscardOverAsVoidRule, preferForEachDiscardRule, preferLayerSyncRule, preferOptionNullishGettersRule, } from './effect-prefer-option-get-or-else.js';
|
|
10
|
+
const MESSAGE = diagnosticMessage({
|
|
11
|
+
example: 'import { Option } from "effect"\n\n' +
|
|
12
|
+
'const value = Option.orElseSome(decoded, () => fallback)',
|
|
13
|
+
fix: 'Replace Option.orElse with Option.orElseSome and return the fallback value directly.',
|
|
14
|
+
summary: 'Option.orElseSome expresses an Option.orElse fallback that always wraps a value in Option.some more directly.',
|
|
15
|
+
});
|
|
16
|
+
const literalString = (node) => {
|
|
17
|
+
if (node?.type !== 'Literal') {
|
|
18
|
+
return undefined;
|
|
19
|
+
}
|
|
20
|
+
const value = Reflect.get(node, 'value');
|
|
21
|
+
if (typeof value === 'string') {
|
|
22
|
+
return value;
|
|
23
|
+
}
|
|
24
|
+
return undefined;
|
|
25
|
+
};
|
|
26
|
+
const isTypeImport = (node) => Reflect.get(node, 'importKind') === 'type';
|
|
27
|
+
const isRuntimeOptionImport = (statement) => {
|
|
28
|
+
if (statement.type !== 'ImportDeclaration' ||
|
|
29
|
+
isTypeImport(statement) ||
|
|
30
|
+
!['effect', 'effect/Option'].includes(literalString(childNode(statement, 'source')) ?? '')) {
|
|
31
|
+
return false;
|
|
32
|
+
}
|
|
33
|
+
const specifiers = childNodes(statement, 'specifiers');
|
|
34
|
+
return (specifiers.length === 0 || specifiers.some((specifier) => !isTypeImport(specifier)));
|
|
35
|
+
};
|
|
36
|
+
const hasRuntimeOptionImport = (program) => childNodes(program, 'body').some(isRuntimeOptionImport);
|
|
37
|
+
const addRootPackageNamespace = (namespaces, specifier) => {
|
|
38
|
+
if (specifier.type !== 'ImportNamespaceSpecifier' || isTypeImport(specifier)) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
const localName = identifierName(childNode(specifier, 'local'));
|
|
42
|
+
if (localName) {
|
|
43
|
+
namespaces.add(localName);
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
const rootPackageNamespaces = (program) => {
|
|
47
|
+
const namespaces = new Set();
|
|
48
|
+
for (const statement of childNodes(program, 'body')) {
|
|
49
|
+
if (statement.type === 'ImportDeclaration' &&
|
|
50
|
+
!isTypeImport(statement) &&
|
|
51
|
+
literalString(childNode(statement, 'source')) === 'effect') {
|
|
52
|
+
for (const specifier of childNodes(statement, 'specifiers')) {
|
|
53
|
+
addRootPackageNamespace(namespaces, specifier);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
return namespaces;
|
|
58
|
+
};
|
|
59
|
+
const hasTypeArguments = (node) => Boolean(childNode(node, 'typeArguments') || childNode(node, 'typeParameters'));
|
|
60
|
+
const hasUnsupportedMemberAccess = (node) => node?.type === 'MemberExpression' &&
|
|
61
|
+
(Reflect.get(node, 'computed') === true ||
|
|
62
|
+
Reflect.get(node, 'optional') === true ||
|
|
63
|
+
hasUnsupportedMemberAccess(childNode(node, 'object')));
|
|
64
|
+
const isPlainCall = (call) => Reflect.get(call, 'optional') !== true &&
|
|
65
|
+
!hasTypeArguments(call) &&
|
|
66
|
+
!hasUnsupportedMemberAccess(childNode(call, 'callee'));
|
|
67
|
+
const exactArguments = (call) => {
|
|
68
|
+
if (!isPlainCall(call)) {
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
const callArguments = childNodes(call, 'arguments');
|
|
72
|
+
if (callArguments.some((argument) => argument.type === 'SpreadElement')) {
|
|
73
|
+
return undefined;
|
|
74
|
+
}
|
|
75
|
+
return callArguments;
|
|
76
|
+
};
|
|
77
|
+
const isDirectRootPackageCall = (callee, namespaces) => callee?.type === 'MemberExpression' &&
|
|
78
|
+
namespaces.has(identifierName(childNode(callee, 'object')) ?? '');
|
|
79
|
+
const isConciseFallback = (node) => node?.type === 'ArrowFunctionExpression' &&
|
|
80
|
+
Reflect.get(node, 'async') !== true &&
|
|
81
|
+
Reflect.get(node, 'generator') !== true &&
|
|
82
|
+
Reflect.get(node, 'expression') === true &&
|
|
83
|
+
childNodes(node, 'params').length === 0 &&
|
|
84
|
+
!childNode(node, 'returnType') &&
|
|
85
|
+
!childNode(node, 'typeParameters');
|
|
86
|
+
const isExactSomeFallback = (callback, state) => {
|
|
87
|
+
if (!isConciseFallback(callback)) {
|
|
88
|
+
return false;
|
|
89
|
+
}
|
|
90
|
+
const someCall = childNode(callback, 'body');
|
|
91
|
+
if (someCall?.type !== 'CallExpression') {
|
|
92
|
+
return false;
|
|
93
|
+
}
|
|
94
|
+
const someArguments = exactArguments(someCall);
|
|
95
|
+
const someCallee = childNode(someCall, 'callee');
|
|
96
|
+
return (someArguments?.length === 1 &&
|
|
97
|
+
!isDirectRootPackageCall(someCallee, state.rootPackageNamespaces) &&
|
|
98
|
+
state.optionSome.matches(someCallee));
|
|
99
|
+
};
|
|
100
|
+
const matchingCallee = (call, state) => {
|
|
101
|
+
const callArguments = exactArguments(call);
|
|
102
|
+
if (!callArguments || (callArguments.length !== 1 && callArguments.length !== 2)) {
|
|
103
|
+
return undefined;
|
|
104
|
+
}
|
|
105
|
+
const callee = childNode(call, 'callee');
|
|
106
|
+
const callback = callArguments.at(-1);
|
|
107
|
+
if (!isDirectRootPackageCall(callee, state.rootPackageNamespaces) &&
|
|
108
|
+
state.optionOrElse.matches(callee) &&
|
|
109
|
+
isExactSomeFallback(callback, state)) {
|
|
110
|
+
return callee;
|
|
111
|
+
}
|
|
112
|
+
return undefined;
|
|
113
|
+
};
|
|
114
|
+
const hasCandidateTokens = (source) => source.includes('effect') && source.includes('orElse') && source.includes('some');
|
|
115
|
+
const rule = {
|
|
116
|
+
create(context) {
|
|
117
|
+
if (!hasCandidateTokens(readCachedSource(context))) {
|
|
118
|
+
return { Program() { } };
|
|
119
|
+
}
|
|
120
|
+
let state = undefined;
|
|
121
|
+
return {
|
|
122
|
+
CallExpression(value) {
|
|
123
|
+
const call = asNode(value);
|
|
124
|
+
if (!call || !state) {
|
|
125
|
+
return;
|
|
126
|
+
}
|
|
127
|
+
const callee = matchingCallee(call, state);
|
|
128
|
+
if (callee) {
|
|
129
|
+
context.report({ message: MESSAGE, node: callee });
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
Program(value) {
|
|
133
|
+
const program = asNode(value);
|
|
134
|
+
if (!program || !hasRuntimeOptionImport(program)) {
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
const optionOrElse = importedEffectCallMatcher(context, 'Option', ['orElse']);
|
|
138
|
+
const optionSome = importedEffectCallMatcher(context, 'Option', ['some']);
|
|
139
|
+
optionOrElse.initialize(program);
|
|
140
|
+
optionSome.initialize(program);
|
|
141
|
+
state = {
|
|
142
|
+
optionOrElse,
|
|
143
|
+
optionSome,
|
|
144
|
+
rootPackageNamespaces: rootPackageNamespaces(program),
|
|
145
|
+
};
|
|
146
|
+
},
|
|
147
|
+
};
|
|
148
|
+
},
|
|
149
|
+
meta: {
|
|
150
|
+
docs: {
|
|
151
|
+
description: MESSAGE,
|
|
152
|
+
},
|
|
153
|
+
schema: strictPathOptionsSchema,
|
|
154
|
+
type: 'problem',
|
|
155
|
+
},
|
|
156
|
+
};
|
|
157
|
+
export default rule;
|
|
158
|
+
//# sourceMappingURL=effect-prefer-option-or-else-some.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-option-or-else-some.js","sourceRoot":"","sources":["../../src/rules/effect-prefer-option-or-else-some.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAGhF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EACL,OAAO,IAAI,yBAAyB,EACpC,oBAAoB,EACpB,qCAAqC,EACrC,wBAAwB,EACxB,mBAAmB,EACnB,8BAA8B,GAC/B,MAAM,oCAAoC,CAAC;AAQ5C,MAAM,OAAO,GAAG,iBAAiB,CAAC;IAChC,OAAO,EACL,qCAAqC;QACrC,0DAA0D;IAC5D,GAAG,EAAE,sFAAsF;IAC3F,OAAO,EACL,+GAA+G;CAClH,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,IAAyB,EAAsB,EAAE;IACtE,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAa,EAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,MAAM,CAAC;AAE5F,MAAM,qBAAqB,GAAG,CAAC,SAAkB,EAAW,EAAE;IAC5D,IACE,SAAS,CAAC,IAAI,KAAK,mBAAmB;QACtC,YAAY,CAAC,SAAS,CAAC;QACvB,CAAC,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,EAC1F,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACvD,OAAO,CACL,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAW,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAC7F,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAgB,EAAW,EAAE,CAC3D,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;AAE1D,MAAM,uBAAuB,GAAG,CAAC,UAAuB,EAAE,SAAkB,EAAQ,EAAE;IACpF,IAAI,SAAS,CAAC,IAAI,KAAK,0BAA0B,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7E,OAAO;IACT,CAAC;IACD,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IAChE,IAAI,SAAS,EAAE,CAAC;QACd,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAuB,EAAE;IACtE,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QACpD,IACE,SAAS,CAAC,IAAI,KAAK,mBAAmB;YACtC,CAAC,YAAY,CAAC,SAAS,CAAC;YACxB,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,KAAK,QAAQ,EAC1D,CAAC;YACD,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC5D,uBAAuB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAW,EAAE,CAClD,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAEjF,MAAM,0BAA0B,GAAG,CAAC,IAAyB,EAAW,EAAE,CACxE,IAAI,EAAE,IAAI,KAAK,kBAAkB;IACjC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;QACrC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;QACtC,0BAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAE3D,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;IACtC,CAAC,gBAAgB,CAAC,IAAI,CAAC;IACvB,CAAC,0BAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEzD,MAAM,cAAc,GAAG,CAAC,IAAa,EAAyB,EAAE;IAC9D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACpD,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,eAAe,CAAC,EAAE,CAAC;QACjF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC9B,MAA2B,EAC3B,UAA+B,EACtB,EAAE,CACX,MAAM,EAAE,IAAI,KAAK,kBAAkB;IACnC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAEpE,MAAM,iBAAiB,GAAG,CAAC,IAAyB,EAAmB,EAAE,CACvE,IAAI,EAAE,IAAI,KAAK,yBAAyB;IACxC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI;IACnC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI;IACvC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,IAAI;IACxC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC;IACvC,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC;IAC9B,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAErC,MAAM,mBAAmB,GAAG,CAAC,QAA6B,EAAE,KAAmB,EAAW,EAAE;IAC1F,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7C,IAAI,QAAQ,EAAE,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,aAAa,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,OAAO,CACL,aAAa,EAAE,MAAM,KAAK,CAAC;QAC3B,CAAC,uBAAuB,CAAC,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC;QACjE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAE,KAAmB,EAAuB,EAAE;IACjF,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,CAAC,aAAa,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;QACjF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,IACE,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,CAAC;QAC7D,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,EACpC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAW,EAAE,CACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAEpF,MAAM,IAAI,GAAe;IACvB,MAAM,CAAC,OAAgB;QACrB,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,EAAE,OAAO,KAAU,CAAC,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,KAAK,GAA6B,SAAS,CAAC;QAEhD,OAAO;YACL,cAAc,CAAC,KAAK;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO;gBACT,CAAC;gBACD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC3C,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;YACD,OAAO,CAAC,KAAK;gBACX,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBACD,MAAM,YAAY,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC9E,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC1E,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACjC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC/B,KAAK,GAAG;oBACN,YAAY;oBACZ,UAAU;oBACV,qBAAqB,EAAE,qBAAqB,CAAC,OAAO,CAAC;iBACtD,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,OAAO;SACrB;QACD,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { SourceRule } from './effect-rule-core';
|
|
2
|
+
export { default as preferOptionOrElseSomeRule, preferAllDiscardRule, preferCollectionDiscardOverAsVoidRule, preferForEachDiscardRule, preferLayerSyncRule, preferOptionGetOrElseRule, preferOptionNullishGettersRule, } from './effect-prefer-option-or-else-some';
|
|
3
|
+
declare const rule: SourceRule;
|
|
4
|
+
export default rule;
|
|
5
|
+
//# sourceMappingURL=effect-prefer-ref-get-and-update.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-ref-get-and-update.d.ts","sourceRoot":"","sources":["../../src/rules/effect-prefer-ref-get-and-update.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAS9D,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,oBAAoB,EACpB,qCAAqC,EACrC,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,qCAAqC,CAAC;AAiL7C,QAAA,MAAM,IAAI,EAAE,UAsCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
/* -------------------------------------------------------------------------- */
|
|
2
|
+
/* Prefer Ref.getAndUpdate over Ref.modify identity result tuples. */
|
|
3
|
+
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { asNode, childNode, childNodes, identifierName } from './effect-ast.js';
|
|
5
|
+
import { diagnosticMessage } from './diagnostic-guidance.js';
|
|
6
|
+
import { importedEffectCallMatcher } from './effect-imported-call-matcher.js';
|
|
7
|
+
import { readCachedSource } from './source-cache.js';
|
|
8
|
+
import { strictPathOptionsSchema } from './effect-path-options.js';
|
|
9
|
+
export { default as preferOptionOrElseSomeRule, preferAllDiscardRule, preferCollectionDiscardOverAsVoidRule, preferForEachDiscardRule, preferLayerSyncRule, preferOptionGetOrElseRule, preferOptionNullishGettersRule, } from './effect-prefer-option-or-else-some.js';
|
|
10
|
+
const MESSAGE = diagnosticMessage({
|
|
11
|
+
example: 'import { Ref } from "effect"\n\n' +
|
|
12
|
+
'const previous = Ref.getAndUpdate(ref, (current) => current + 1)',
|
|
13
|
+
fix: 'Replace Ref.modify with Ref.getAndUpdate and return only the new Ref value from the callback.',
|
|
14
|
+
summary: 'Ref.getAndUpdate expresses a Ref.modify callback that returns the current value while updating the Ref more directly.',
|
|
15
|
+
});
|
|
16
|
+
const literalString = (node) => {
|
|
17
|
+
if (node?.type !== 'Literal') {
|
|
18
|
+
return undefined;
|
|
19
|
+
}
|
|
20
|
+
const value = Reflect.get(node, 'value');
|
|
21
|
+
if (typeof value === 'string') {
|
|
22
|
+
return value;
|
|
23
|
+
}
|
|
24
|
+
return undefined;
|
|
25
|
+
};
|
|
26
|
+
const isRefImport = (statement) => {
|
|
27
|
+
if (statement.type !== 'ImportDeclaration') {
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
const source = literalString(childNode(statement, 'source'));
|
|
31
|
+
return source === 'effect' || source === 'effect/Ref';
|
|
32
|
+
};
|
|
33
|
+
const hasRefImport = (program) => childNodes(program, 'body').some(isRefImport);
|
|
34
|
+
const hasTypeArguments = (node) => Boolean(childNode(node, 'typeArguments') || childNode(node, 'typeParameters'));
|
|
35
|
+
const hasUnsupportedMemberAccess = (node) => node?.type === 'MemberExpression' &&
|
|
36
|
+
(Reflect.get(node, 'computed') === true ||
|
|
37
|
+
Reflect.get(node, 'optional') === true ||
|
|
38
|
+
hasUnsupportedMemberAccess(childNode(node, 'object')));
|
|
39
|
+
const isPlainCall = (call) => Reflect.get(call, 'optional') !== true &&
|
|
40
|
+
!hasTypeArguments(call) &&
|
|
41
|
+
!hasUnsupportedMemberAccess(childNode(call, 'callee'));
|
|
42
|
+
const exactArguments = (call) => {
|
|
43
|
+
if (!isPlainCall(call)) {
|
|
44
|
+
return undefined;
|
|
45
|
+
}
|
|
46
|
+
const callArguments = childNodes(call, 'arguments');
|
|
47
|
+
if ((callArguments.length !== 1 && callArguments.length !== 2) ||
|
|
48
|
+
callArguments.some((argument) => argument.type === 'SpreadElement')) {
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
return callArguments;
|
|
52
|
+
};
|
|
53
|
+
const isExactConstAssertion = (node) => {
|
|
54
|
+
const annotation = childNode(node, 'typeAnnotation');
|
|
55
|
+
return (annotation?.type === 'TSTypeReference' &&
|
|
56
|
+
identifierName(childNode(annotation, 'typeName')) === 'const' &&
|
|
57
|
+
!hasTypeArguments(annotation));
|
|
58
|
+
};
|
|
59
|
+
const tupleBody = (expression, hasConstAssertion = false) => {
|
|
60
|
+
if (expression?.type === 'ParenthesizedExpression') {
|
|
61
|
+
return tupleBody(childNode(expression, 'expression'), hasConstAssertion);
|
|
62
|
+
}
|
|
63
|
+
if (expression?.type === 'TSAsExpression') {
|
|
64
|
+
if (hasConstAssertion || !isExactConstAssertion(expression)) {
|
|
65
|
+
return undefined;
|
|
66
|
+
}
|
|
67
|
+
return tupleBody(childNode(expression, 'expression'), true);
|
|
68
|
+
}
|
|
69
|
+
if (expression?.type !== 'ArrayExpression') {
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
return expression;
|
|
73
|
+
};
|
|
74
|
+
const isUnknownArray = (value) => Array.isArray(value);
|
|
75
|
+
const rawTupleElements = (array) => {
|
|
76
|
+
const elements = Reflect.get(array, 'elements');
|
|
77
|
+
if (!isUnknownArray(elements) || elements.length !== 2) {
|
|
78
|
+
return undefined;
|
|
79
|
+
}
|
|
80
|
+
const first = asNode(elements[0]);
|
|
81
|
+
const second = asNode(elements[1]);
|
|
82
|
+
if (!first || !second || first.type === 'SpreadElement' || second.type === 'SpreadElement') {
|
|
83
|
+
return undefined;
|
|
84
|
+
}
|
|
85
|
+
return [first, second];
|
|
86
|
+
};
|
|
87
|
+
const isConciseUntypedArrow = (node) => node?.type === 'ArrowFunctionExpression' &&
|
|
88
|
+
Reflect.get(node, 'async') !== true &&
|
|
89
|
+
Reflect.get(node, 'generator') !== true &&
|
|
90
|
+
Reflect.get(node, 'expression') === true &&
|
|
91
|
+
!childNode(node, 'returnType') &&
|
|
92
|
+
!childNode(node, 'typeParameters');
|
|
93
|
+
const callbackParameterName = (arrow) => {
|
|
94
|
+
const parameters = childNodes(arrow, 'params');
|
|
95
|
+
if (parameters.length !== 1) {
|
|
96
|
+
return undefined;
|
|
97
|
+
}
|
|
98
|
+
const [parameter] = parameters;
|
|
99
|
+
const parameterName = identifierName(parameter);
|
|
100
|
+
if (!parameter ||
|
|
101
|
+
!parameterName ||
|
|
102
|
+
Reflect.get(parameter, 'optional') === true ||
|
|
103
|
+
childNode(parameter, 'typeAnnotation')) {
|
|
104
|
+
return undefined;
|
|
105
|
+
}
|
|
106
|
+
return parameterName;
|
|
107
|
+
};
|
|
108
|
+
const isCurrentValueTuple = (body, parameterName) => {
|
|
109
|
+
const array = tupleBody(body);
|
|
110
|
+
if (!array) {
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
const elements = rawTupleElements(array);
|
|
114
|
+
if (!elements) {
|
|
115
|
+
return false;
|
|
116
|
+
}
|
|
117
|
+
const [first, second] = elements;
|
|
118
|
+
return identifierName(first) === parameterName && identifierName(second) !== parameterName;
|
|
119
|
+
};
|
|
120
|
+
const isExactModifyCallback = (node) => {
|
|
121
|
+
if (!isConciseUntypedArrow(node)) {
|
|
122
|
+
return false;
|
|
123
|
+
}
|
|
124
|
+
const parameterName = callbackParameterName(node);
|
|
125
|
+
if (!parameterName) {
|
|
126
|
+
return false;
|
|
127
|
+
}
|
|
128
|
+
return isCurrentValueTuple(childNode(node, 'body'), parameterName);
|
|
129
|
+
};
|
|
130
|
+
const matchingCallee = (call, state) => {
|
|
131
|
+
const callArguments = exactArguments(call);
|
|
132
|
+
if (!callArguments || !isExactModifyCallback(callArguments.at(-1))) {
|
|
133
|
+
return undefined;
|
|
134
|
+
}
|
|
135
|
+
const callee = childNode(call, 'callee');
|
|
136
|
+
if (state.refModify.matches(callee) && !state.rootModify.matches(callee)) {
|
|
137
|
+
return callee;
|
|
138
|
+
}
|
|
139
|
+
return undefined;
|
|
140
|
+
};
|
|
141
|
+
const hasCandidateTokens = (source) => source.includes('effect') &&
|
|
142
|
+
source.includes('Ref') &&
|
|
143
|
+
source.includes('modify') &&
|
|
144
|
+
source.includes('=>') &&
|
|
145
|
+
source.includes('[');
|
|
146
|
+
const rule = {
|
|
147
|
+
create(context) {
|
|
148
|
+
if (!hasCandidateTokens(readCachedSource(context))) {
|
|
149
|
+
return { Program() { } };
|
|
150
|
+
}
|
|
151
|
+
let state = undefined;
|
|
152
|
+
return {
|
|
153
|
+
CallExpression(value) {
|
|
154
|
+
const call = asNode(value);
|
|
155
|
+
if (!call || !state) {
|
|
156
|
+
return;
|
|
157
|
+
}
|
|
158
|
+
const callee = matchingCallee(call, state);
|
|
159
|
+
if (callee) {
|
|
160
|
+
context.report({ message: MESSAGE, node: callee });
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
Program(value) {
|
|
164
|
+
const program = asNode(value);
|
|
165
|
+
if (!program || !hasRefImport(program)) {
|
|
166
|
+
return;
|
|
167
|
+
}
|
|
168
|
+
const refModify = importedEffectCallMatcher(context, 'Ref', ['modify']);
|
|
169
|
+
const rootModify = importedEffectCallMatcher(context, 'Effect', ['modify']);
|
|
170
|
+
refModify.initialize(program);
|
|
171
|
+
rootModify.initialize(program);
|
|
172
|
+
state = { refModify, rootModify };
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
},
|
|
176
|
+
meta: {
|
|
177
|
+
docs: {
|
|
178
|
+
description: MESSAGE,
|
|
179
|
+
},
|
|
180
|
+
schema: strictPathOptionsSchema,
|
|
181
|
+
type: 'problem',
|
|
182
|
+
},
|
|
183
|
+
};
|
|
184
|
+
export default rule;
|
|
185
|
+
//# sourceMappingURL=effect-prefer-ref-get-and-update.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-ref-get-and-update.js","sourceRoot":"","sources":["../../src/rules/effect-prefer-ref-get-and-update.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAGhF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,oBAAoB,EACpB,qCAAqC,EACrC,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,qCAAqC,CAAC;AAO7C,MAAM,OAAO,GAAG,iBAAiB,CAAC;IAChC,OAAO,EACL,kCAAkC;QAClC,kEAAkE;IACpE,GAAG,EAAE,+FAA+F;IACpG,OAAO,EACL,uHAAuH;CAC1H,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,IAAyB,EAAsB,EAAE;IACtE,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAkB,EAAW,EAAE;IAClD,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,YAAY,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAW,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAElG,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAW,EAAE,CAClD,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAEjF,MAAM,0BAA0B,GAAG,CAAC,IAAyB,EAAW,EAAE,CACxE,IAAI,EAAE,IAAI,KAAK,kBAAkB;IACjC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;QACrC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;QACtC,0BAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAE3D,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI;IACtC,CAAC,gBAAgB,CAAC,IAAI,CAAC;IACvB,CAAC,0BAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEzD,MAAM,cAAc,GAAG,CAAC,IAAa,EAAyB,EAAE;IAC9D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACpD,IACE,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1D,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,eAAe,CAAC,EAC5E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,IAAa,EAAW,EAAE;IACvD,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACrD,OAAO,CACL,UAAU,EAAE,IAAI,KAAK,iBAAiB;QACtC,cAAc,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,KAAK,OAAO;QAC7D,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAC9B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAChB,UAA+B,EAC/B,iBAAiB,GAAG,KAAK,EACJ,EAAE;IACvB,IAAI,UAAU,EAAE,IAAI,KAAK,yBAAyB,EAAE,CAAC;QACnD,OAAO,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,UAAU,EAAE,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC1C,IAAI,iBAAiB,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,UAAU,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAc,EAA+B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE7F,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAkC,EAAE;IAC1E,MAAM,QAAQ,GAAY,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACzD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,IAAI,MAAM,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAC3F,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,IAAyB,EAAmB,EAAE,CAC3E,IAAI,EAAE,IAAI,KAAK,yBAAyB;IACxC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI;IACnC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI;IACvC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,IAAI;IACxC,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC;IAC9B,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAErC,MAAM,qBAAqB,GAAG,CAAC,KAAc,EAAsB,EAAE;IACnE,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;IAC/B,MAAM,aAAa,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAChD,IACE,CAAC,SAAS;QACV,CAAC,aAAa;QACd,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,IAAI;QAC3C,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC,EACtC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAyB,EAAE,aAAqB,EAAW,EAAE;IACxF,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;IACjC,OAAO,cAAc,CAAC,KAAK,CAAC,KAAK,aAAa,IAAI,cAAc,CAAC,MAAM,CAAC,KAAK,aAAa,CAAC;AAC7F,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,IAAyB,EAAW,EAAE;IACnE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,aAAa,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,aAAa,CAAC,CAAC;AACrE,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAE,KAAmB,EAAuB,EAAE;IACjF,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,CAAC,aAAa,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzC,IAAI,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACzE,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAW,EAAE,CACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACzB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;IACtB,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IACrB,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAEvB,MAAM,IAAI,GAAe;IACvB,MAAM,CAAC,OAAgB;QACrB,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,EAAE,OAAO,KAAU,CAAC,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,KAAK,GAA6B,SAAS,CAAC;QAChD,OAAO;YACL,cAAc,CAAC,KAAK;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO;gBACT,CAAC;gBACD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC3C,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;YACD,OAAO,CAAC,KAAK;gBACX,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;oBACvC,OAAO;gBACT,CAAC;gBACD,MAAM,SAAS,GAAG,yBAAyB,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxE,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC5E,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC9B,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC/B,KAAK,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;YACpC,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,OAAO;SACrB;QACD,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-succeed-none.d.ts","sourceRoot":"","sources":["../../src/rules/effect-prefer-succeed-none.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA6E9D,QAAA,MAAM,IAAI,EAAE,UAgDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
/* -------------------------------------------------------------------------- */
|
|
2
|
+
/* Prefer Effect.succeedNone over succeeding with Option.none. */
|
|
3
|
+
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { asNode, childNode, childNodes } from './effect-ast.js';
|
|
5
|
+
import { diagnosticMessage } from './diagnostic-guidance.js';
|
|
6
|
+
import { importedEffectCallMatcher } from './effect-imported-call-matcher.js';
|
|
7
|
+
import { readCachedSource } from './source-cache.js';
|
|
8
|
+
import { strictPathOptionsSchema } from './effect-path-options.js';
|
|
9
|
+
const MESSAGE = diagnosticMessage({
|
|
10
|
+
example: 'import { Effect } from "effect"\n\nconst task = Effect.succeedNone',
|
|
11
|
+
fix: 'Use the succeedNone export from the same Effect import style instead of nesting succeed around Option.none().',
|
|
12
|
+
summary: 'Effect.succeedNone expresses a successful None more directly than Effect.succeed(Option.none()).',
|
|
13
|
+
});
|
|
14
|
+
const literalString = (node) => {
|
|
15
|
+
if (node?.type !== 'Literal') {
|
|
16
|
+
return undefined;
|
|
17
|
+
}
|
|
18
|
+
const value = Reflect.get(node, 'value');
|
|
19
|
+
if (typeof value === 'string') {
|
|
20
|
+
return value;
|
|
21
|
+
}
|
|
22
|
+
return undefined;
|
|
23
|
+
};
|
|
24
|
+
const isEffectImport = (statement) => {
|
|
25
|
+
if (statement.type !== 'ImportDeclaration') {
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
const source = literalString(childNode(statement, 'source'));
|
|
29
|
+
return source === 'effect' || source === 'effect/Effect' || source === 'effect/Option';
|
|
30
|
+
};
|
|
31
|
+
const hasEffectImport = (program) => childNodes(program, 'body').some(isEffectImport);
|
|
32
|
+
const hasTypeArguments = (call) => Boolean(childNode(call, 'typeArguments') || childNode(call, 'typeParameters'));
|
|
33
|
+
const hasOptionalMemberAccess = (callee) => {
|
|
34
|
+
if (callee?.type !== 'MemberExpression') {
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
if (Reflect.get(callee, 'optional') === true) {
|
|
38
|
+
return true;
|
|
39
|
+
}
|
|
40
|
+
return hasOptionalMemberAccess(childNode(callee, 'object'));
|
|
41
|
+
};
|
|
42
|
+
const isOptionalCall = (call) => Reflect.get(call, 'optional') === true || hasOptionalMemberAccess(childNode(call, 'callee'));
|
|
43
|
+
const isPlainCall = (call) => !isOptionalCall(call) && !hasTypeArguments(call);
|
|
44
|
+
const directNoneCallFor = (succeedCall) => {
|
|
45
|
+
if (!isPlainCall(succeedCall)) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
const succeedArguments = childNodes(succeedCall, 'arguments');
|
|
49
|
+
if (succeedArguments.length !== 1) {
|
|
50
|
+
return undefined;
|
|
51
|
+
}
|
|
52
|
+
const [noneCall] = succeedArguments;
|
|
53
|
+
if (noneCall?.type !== 'CallExpression' ||
|
|
54
|
+
!isPlainCall(noneCall) ||
|
|
55
|
+
childNodes(noneCall, 'arguments').length !== 0) {
|
|
56
|
+
return undefined;
|
|
57
|
+
}
|
|
58
|
+
return noneCall;
|
|
59
|
+
};
|
|
60
|
+
const hasCandidateTokens = (source) => Math.min(source.indexOf('succeed'), source.indexOf('none')) >= 0;
|
|
61
|
+
const rule = {
|
|
62
|
+
create(context) {
|
|
63
|
+
const source = readCachedSource(context);
|
|
64
|
+
if (!hasCandidateTokens(source)) {
|
|
65
|
+
return { Program() { } };
|
|
66
|
+
}
|
|
67
|
+
const effectSucceed = importedEffectCallMatcher(context, 'Effect', ['succeed']);
|
|
68
|
+
const optionNone = importedEffectCallMatcher(context, 'Option', ['none']);
|
|
69
|
+
let hasImportedEffectAPI = false;
|
|
70
|
+
return {
|
|
71
|
+
CallExpression(value) {
|
|
72
|
+
if (!hasImportedEffectAPI) {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
const succeedCall = asNode(value);
|
|
76
|
+
if (!succeedCall) {
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
const noneCall = directNoneCallFor(succeedCall);
|
|
80
|
+
if (!noneCall ||
|
|
81
|
+
!effectSucceed.matches(childNode(succeedCall, 'callee')) ||
|
|
82
|
+
!optionNone.matches(childNode(noneCall, 'callee'))) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
context.report({ message: MESSAGE, node: childNode(succeedCall, 'callee') ?? succeedCall });
|
|
86
|
+
},
|
|
87
|
+
Program(value) {
|
|
88
|
+
const program = asNode(value);
|
|
89
|
+
if (!program || !hasEffectImport(program)) {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
hasImportedEffectAPI = true;
|
|
93
|
+
effectSucceed.initialize(program);
|
|
94
|
+
optionNone.initialize(program);
|
|
95
|
+
},
|
|
96
|
+
};
|
|
97
|
+
},
|
|
98
|
+
meta: {
|
|
99
|
+
docs: {
|
|
100
|
+
description: MESSAGE,
|
|
101
|
+
},
|
|
102
|
+
schema: strictPathOptionsSchema,
|
|
103
|
+
type: 'problem',
|
|
104
|
+
},
|
|
105
|
+
};
|
|
106
|
+
export default rule;
|
|
107
|
+
//# sourceMappingURL=effect-prefer-succeed-none.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-succeed-none.js","sourceRoot":"","sources":["../../src/rules/effect-prefer-succeed-none.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAGhF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,OAAO,GAAG,iBAAiB,CAAC;IAChC,OAAO,EAAE,oEAAoE;IAC7E,GAAG,EAAE,+GAA+G;IACpH,OAAO,EACL,kGAAkG;CACrG,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,IAAyB,EAAsB,EAAE;IACtE,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAW,EAAE;IACrD,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,eAAe,IAAI,MAAM,KAAK,eAAe,CAAC;AACzF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAW,EAAE,CACpD,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAEnD,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAW,EAAE,CAClD,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAEjF,MAAM,uBAAuB,GAAG,CAAC,MAA2B,EAAW,EAAE;IACvE,IAAI,MAAM,EAAE,IAAI,KAAK,kBAAkB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,uBAAuB,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAW,EAAE,CAChD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI,uBAAuB,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE/F,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AAEjG,MAAM,iBAAiB,GAAG,CAAC,WAAoB,EAAuB,EAAE;IACtE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9D,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC;IACpC,IACE,QAAQ,EAAE,IAAI,KAAK,gBAAgB;QACnC,CAAC,WAAW,CAAC,QAAQ,CAAC;QACtB,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAC9C,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAW,EAAE,CACrD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;AAEnE,MAAM,IAAI,GAAe;IACvB,MAAM,CAAC,OAAgB;QACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,OAAO,KAAU,CAAC,EAAE,CAAC;QAChC,CAAC;QAED,MAAM,aAAa,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAChF,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,IAAI,oBAAoB,GAAG,KAAK,CAAC;QAEjC,OAAO;YACL,cAAc,CAAC,KAAK;gBAClB,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC1B,OAAO;gBACT,CAAC;gBACD,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;gBAChD,IACE,CAAC,QAAQ;oBACT,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;oBACxD,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAClD,CAAC;oBACD,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,OAAO,CAAC,KAAK;gBACX,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBACD,oBAAoB,GAAG,IAAI,CAAC;gBAC5B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,OAAO;SACrB;QACD,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-succeed-some.d.ts","sourceRoot":"","sources":["../../src/rules/effect-prefer-succeed-some.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAuF9D,QAAA,MAAM,IAAI,EAAE,UAgDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
/* -------------------------------------------------------------------------- */
|
|
2
|
+
/* Prefer Effect.succeedSome over succeeding with Option.some. */
|
|
3
|
+
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { asNode, childNode, childNodes } from './effect-ast.js';
|
|
5
|
+
import { diagnosticMessage } from './diagnostic-guidance.js';
|
|
6
|
+
import { importedEffectCallMatcher } from './effect-imported-call-matcher.js';
|
|
7
|
+
import { readCachedSource } from './source-cache.js';
|
|
8
|
+
import { strictPathOptionsSchema } from './effect-path-options.js';
|
|
9
|
+
const MESSAGE = diagnosticMessage({
|
|
10
|
+
example: 'import { Effect } from "effect"\n\nconst task = Effect.succeedSome(value)',
|
|
11
|
+
fix: 'Use the succeedSome export from the same Effect import style and pass the value directly.',
|
|
12
|
+
summary: 'Effect.succeedSome expresses a successful Some more directly than Effect.succeed(Option.some(value)).',
|
|
13
|
+
});
|
|
14
|
+
const literalString = (node) => {
|
|
15
|
+
if (node?.type !== 'Literal') {
|
|
16
|
+
return undefined;
|
|
17
|
+
}
|
|
18
|
+
const value = Reflect.get(node, 'value');
|
|
19
|
+
if (typeof value === 'string') {
|
|
20
|
+
return value;
|
|
21
|
+
}
|
|
22
|
+
return undefined;
|
|
23
|
+
};
|
|
24
|
+
const isEffectImport = (statement) => {
|
|
25
|
+
if (statement.type !== 'ImportDeclaration') {
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
const source = literalString(childNode(statement, 'source'));
|
|
29
|
+
return source === 'effect' || source === 'effect/Effect' || source === 'effect/Option';
|
|
30
|
+
};
|
|
31
|
+
const hasEffectImport = (program) => childNodes(program, 'body').some(isEffectImport);
|
|
32
|
+
const hasTypeArguments = (call) => Boolean(childNode(call, 'typeArguments') || childNode(call, 'typeParameters'));
|
|
33
|
+
const hasOptionalMemberAccess = (callee) => {
|
|
34
|
+
if (callee?.type !== 'MemberExpression') {
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
if (Reflect.get(callee, 'optional') === true) {
|
|
38
|
+
return true;
|
|
39
|
+
}
|
|
40
|
+
return hasOptionalMemberAccess(childNode(callee, 'object'));
|
|
41
|
+
};
|
|
42
|
+
const isOptionalCall = (call) => Reflect.get(call, 'optional') === true || hasOptionalMemberAccess(childNode(call, 'callee'));
|
|
43
|
+
const isPlainCall = (call) => !isOptionalCall(call) && !hasTypeArguments(call);
|
|
44
|
+
const parenthesizedExpression = (node) => {
|
|
45
|
+
if (node?.type === 'ParenthesizedExpression') {
|
|
46
|
+
return parenthesizedExpression(childNode(node, 'expression'));
|
|
47
|
+
}
|
|
48
|
+
return node;
|
|
49
|
+
};
|
|
50
|
+
const singleNonSpreadArgument = (call) => {
|
|
51
|
+
const callArguments = childNodes(call, 'arguments');
|
|
52
|
+
if (callArguments.length !== 1 || callArguments[0]?.type === 'SpreadElement') {
|
|
53
|
+
return undefined;
|
|
54
|
+
}
|
|
55
|
+
return callArguments[0];
|
|
56
|
+
};
|
|
57
|
+
const directSomeCallFor = (succeedCall) => {
|
|
58
|
+
if (!isPlainCall(succeedCall)) {
|
|
59
|
+
return undefined;
|
|
60
|
+
}
|
|
61
|
+
const someCall = parenthesizedExpression(singleNonSpreadArgument(succeedCall));
|
|
62
|
+
if (someCall?.type !== 'CallExpression' || !isPlainCall(someCall)) {
|
|
63
|
+
return undefined;
|
|
64
|
+
}
|
|
65
|
+
if (!singleNonSpreadArgument(someCall)) {
|
|
66
|
+
return undefined;
|
|
67
|
+
}
|
|
68
|
+
return someCall;
|
|
69
|
+
};
|
|
70
|
+
const hasCandidateTokens = (source) => Math.min(source.indexOf('succeed'), source.indexOf('some')) >= 0;
|
|
71
|
+
const rule = {
|
|
72
|
+
create(context) {
|
|
73
|
+
const source = readCachedSource(context);
|
|
74
|
+
if (!hasCandidateTokens(source)) {
|
|
75
|
+
return { Program() { } };
|
|
76
|
+
}
|
|
77
|
+
const effectSucceed = importedEffectCallMatcher(context, 'Effect', ['succeed']);
|
|
78
|
+
const optionSome = importedEffectCallMatcher(context, 'Option', ['some']);
|
|
79
|
+
let hasImportedEffectAPI = false;
|
|
80
|
+
return {
|
|
81
|
+
CallExpression(value) {
|
|
82
|
+
if (!hasImportedEffectAPI) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
const succeedCall = asNode(value);
|
|
86
|
+
if (!succeedCall) {
|
|
87
|
+
return;
|
|
88
|
+
}
|
|
89
|
+
const someCall = directSomeCallFor(succeedCall);
|
|
90
|
+
if (!someCall ||
|
|
91
|
+
!effectSucceed.matches(childNode(succeedCall, 'callee')) ||
|
|
92
|
+
!optionSome.matches(childNode(someCall, 'callee'))) {
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
context.report({ message: MESSAGE, node: childNode(succeedCall, 'callee') ?? succeedCall });
|
|
96
|
+
},
|
|
97
|
+
Program(value) {
|
|
98
|
+
const program = asNode(value);
|
|
99
|
+
if (!program || !hasEffectImport(program)) {
|
|
100
|
+
return;
|
|
101
|
+
}
|
|
102
|
+
hasImportedEffectAPI = true;
|
|
103
|
+
effectSucceed.initialize(program);
|
|
104
|
+
optionSome.initialize(program);
|
|
105
|
+
},
|
|
106
|
+
};
|
|
107
|
+
},
|
|
108
|
+
meta: {
|
|
109
|
+
docs: {
|
|
110
|
+
description: MESSAGE,
|
|
111
|
+
},
|
|
112
|
+
schema: strictPathOptionsSchema,
|
|
113
|
+
type: 'problem',
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
export default rule;
|
|
117
|
+
//# sourceMappingURL=effect-prefer-succeed-some.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"effect-prefer-succeed-some.js","sourceRoot":"","sources":["../../src/rules/effect-prefer-succeed-some.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAGhF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,OAAO,GAAG,iBAAiB,CAAC;IAChC,OAAO,EAAE,2EAA2E;IACpF,GAAG,EAAE,2FAA2F;IAChG,OAAO,EACL,uGAAuG;CAC1G,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,IAAyB,EAAsB,EAAE;IACtE,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAW,EAAE;IACrD,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,eAAe,IAAI,MAAM,KAAK,eAAe,CAAC;AACzF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAW,EAAE,CACpD,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAEnD,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAW,EAAE,CAClD,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAEjF,MAAM,uBAAuB,GAAG,CAAC,MAA2B,EAAW,EAAE;IACvE,IAAI,MAAM,EAAE,IAAI,KAAK,kBAAkB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,uBAAuB,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAW,EAAE,CAChD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI,uBAAuB,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE/F,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AAEjG,MAAM,uBAAuB,GAAG,CAAC,IAAyB,EAAuB,EAAE;IACjF,IAAI,IAAI,EAAE,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC7C,OAAO,uBAAuB,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,IAAa,EAAuB,EAAE;IACrE,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACpD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,eAAe,EAAE,CAAC;QAC7E,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,WAAoB,EAAuB,EAAE;IACtE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,CAAC;IAC/E,IAAI,QAAQ,EAAE,IAAI,KAAK,gBAAgB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAW,EAAE,CACrD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;AAEnE,MAAM,IAAI,GAAe;IACvB,MAAM,CAAC,OAAgB;QACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,OAAO,KAAU,CAAC,EAAE,CAAC;QAChC,CAAC;QAED,MAAM,aAAa,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAChF,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,IAAI,oBAAoB,GAAG,KAAK,CAAC;QAEjC,OAAO;YACL,cAAc,CAAC,KAAK;gBAClB,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC1B,OAAO;gBACT,CAAC;gBACD,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;gBAChD,IACE,CAAC,QAAQ;oBACT,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;oBACxD,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAClD,CAAC;oBACD,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,OAAO,CAAC,KAAK;gBACX,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC9B,IAAI,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBACD,oBAAoB,GAAG,IAAI,CAAC;gBAC5B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,OAAO;SACrB;QACD,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}
|