rule: strict-effect-handlers

README.md

@@ -51,6 +51,7 @@ To configure individual rules:
 - [effector/no-watch](rules/no-watch/no-watch.md)
 - [effector/no-unnecessary-combination](rules/no-unnecessary-combination/no-unnecessary-combination.md)
 - [effector/no-duplicate-on](rules/no-duplicate-on/no-duplicate-on.md)
+- [effector/strict-effect-handlers](rules/strict-effect-handlers/strict-effect-handlers.md)
 
 ## Maintenance
 

index.js

@@ -10,6 +10,7 @@ module.exports = {
     "no-watch": require("./rules/no-watch/no-watch"),
     "no-unnecessary-combination": require("./rules/no-unnecessary-combination/no-unnecessary-combination"),
     "no-duplicate-on": require("./rules/no-duplicate-on/no-duplicate-on"),
+    "strict-effect-handlers": require("./rules/strict-effect-handlers/strict-effect-handlers"),
   },
   configs: {
     recommended: require("./config/recommended"),

rules/enforce-effect-naming-convention/enforce-effect-naming-convention.js

@@ -2,7 +2,8 @@ const {
   extractImportedFromEffector,
 } = require("../../utils/extract-imported-from-effector");
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
-const { hasEffectorType } = require("../../utils/has-effector-type");
+const { nodeTypeIs } = require("../../utils/node-type-is");
+const { namingOf } = require("../../utils/naming");
 
 module.exports = {
   meta: {
@@ -28,11 +29,9 @@ module.exports = {
     if (parserServices.hasFullTypeInformation) {
       return {
         VariableDeclarator(node) {
-          const isEffectorEffect = hasEffectorType({
+          const isEffectorEffect = nodeTypeIs.effect({
             node,
             context,
-            typeNames: ["Effect"],
-            useInitializer: true,
           });
 
           if (!isEffectorEffect) {
@@ -41,11 +40,9 @@ module.exports = {
 
           const effectName = node.id.name;
 
-          if (effectName?.endsWith("Fx")) {
-            return;
+          if (namingOf.effect.isInvalid({ name: effectName })) {
+            reportEffectNameConventionViolation({ context, node, effectName });
           }
-
-          reportEffectNameConventionViolation({ context, node, effectName });
         },
       };
     }
@@ -77,7 +74,7 @@ module.exports = {
           }
 
           const effectName = node.parent.id.name;
-          if (effectName.endsWith("Fx")) {
+          if (namingOf.effect.isValid({ name: effectName })) {
             continue;
           }
 
@@ -101,7 +98,7 @@ module.exports = {
           }
 
           const effectName = node.parent.id.name;
-          if (effectName.endsWith("Fx")) {
+          if (namingOf.effect.isValid({ name: effectName })) {
             return;
           }
 

rules/enforce-store-naming-convention/enforce-store-naming-convention.js

@@ -1,7 +1,7 @@
 const {
   extractImportedFromEffector,
 } = require("../../utils/extract-imported-from-effector");
-const { isStoreNameValid } = require("../../utils/is-store-name-valid");
+const { namingOf } = require("../../utils/naming");
 const {
   validateStoreNameConvention,
 } = require("../../utils/validate-store-name-convention");
@@ -12,7 +12,7 @@ const {
   getCorrectedStoreName,
 } = require("../../utils/get-corrected-store-name");
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
-const { hasEffectorType } = require("../../utils/has-effector-type");
+const { nodeTypeIs } = require("../../utils/node-type-is");
 
 module.exports = {
   meta: {
@@ -41,11 +41,9 @@ module.exports = {
     if (parserServices.hasFullTypeInformation) {
       return {
         VariableDeclarator(node) {
-          const isEffectorStore = hasEffectorType({
+          const isEffectorStore = nodeTypeIs.store({
             node,
             context,
-            typeNames: ["Store"],
-            useInitializer: true,
           });
 
           if (!isEffectorStore) {
@@ -54,15 +52,13 @@ module.exports = {
 
           const storeName = node.id.name;
 
-          if (isStoreNameValid(storeName, context)) {
-            return;
+          if (namingOf.store.isInvalid({ name: storeName, context })) {
+            reportStoreNameConventionViolation({
+              context,
+              node,
+              storeName,
+            });
           }
-
-          reportStoreNameConventionViolation({
-            context,
-            node,
-            storeName,
-          });
         },
       };
     }
@@ -95,7 +91,7 @@ module.exports = {
 
           const storeName = node.parent.id.name;
 
-          if (isStoreNameValid(storeName, context)) {
+          if (namingOf.store.isValid({ name: storeName, context })) {
             continue;
           }
 
@@ -111,7 +107,9 @@ module.exports = {
         if (node.callee?.property?.name === "map") {
           const storeNameCreatedFromMap = node.callee?.object?.name;
 
-          if (!isStoreNameValid(storeNameCreatedFromMap, context)) {
+          if (
+            namingOf.store.isInvalid({ name: storeNameCreatedFromMap, context })
+          ) {
             return;
           }
 
@@ -123,7 +121,7 @@ module.exports = {
 
           const storeName = node.parent.id.name;
 
-          if (isStoreNameValid(storeName, context)) {
+          if (namingOf.store.isValid({ name: storeName, context })) {
             return;
           }
 
@@ -148,7 +146,7 @@ module.exports = {
 
           const storeName = node.parent.id.name;
 
-          if (isStoreNameValid(storeName, context)) {
+          if (namingOf.store.isValid({ name: storeName, context })) {
             return;
           }
 

rules/no-duplicate-on/no-duplicate-on.js

@@ -1,6 +1,6 @@
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
 const { getNestedObjectName } = require("../../utils/get-nested-object-name");
-const { isStore } = require("../../utils/is");
+const { is } = require("../../utils/is");
 
 module.exports = {
   meta: {
@@ -59,7 +59,7 @@ module.exports = {
         const storeObject = getNestedCallee(node) ?? getAssignedVariable(node);
         const storeName = getStoreName(storeObject);
 
-        if (!isStore({ context, node: storeObject })) {
+        if (!is.store({ context, node: storeObject })) {
           return;
         }
 

rules/no-getState/no-getState.js

@@ -1,9 +1,8 @@
 const {
   traverseNestedObjectNode,
 } = require("../../utils/traverse-nested-object-node");
-const { isStoreNameValid } = require("../../utils/is-store-name-valid");
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
-const { hasEffectorType } = require("../../utils/has-effector-type");
+const { is } = require("../../utils/is");
 
 module.exports = {
   meta: {
@@ -21,46 +20,20 @@ module.exports = {
     schema: [],
   },
   create(context) {
-    const { parserServices } = context;
-
     return {
-      CallExpression(node) {
-        const methodName = node.callee?.property?.name;
-        if (methodName !== "getState") {
-          return;
-        }
+      'CallExpression[callee.property.name="getState"]'(node) {
+        const storeNode = traverseNestedObjectNode(node.callee?.object);
 
-        const object = traverseNestedObjectNode(node.callee?.object);
-        const objectName = object?.name;
+        const isEffectorStore = is.store({
+          context,
+          node: storeNode,
+        });
 
-        if (!objectName) {
+        if (!isEffectorStore) {
           return;
         }
 
-        // TypeScript-way
-        if (parserServices.hasFullTypeInformation) {
-          const isEffectorStore = hasEffectorType({
-            node: object,
-            context,
-            typeNames: ["Store"],
-            useInitializer: false,
-          });
-
-          if (!isEffectorStore) {
-            return;
-          }
-
-          reportGetStateCall({ context, node, storeName: objectName });
-        }
-        // JavaScript-way
-        else {
-          const isEffectorStore = isStoreNameValid(objectName, context);
-          if (!isEffectorStore) {
-            return;
-          }
-
-          reportGetStateCall({ context, node, storeName: objectName });
-        }
+        reportGetStateCall({ context, node, storeName: storeNode.name });
       },
     };
   },

rules/no-watch/no-watch.js

@@ -2,7 +2,7 @@ const {
   traverseNestedObjectNode,
 } = require("../../utils/traverse-nested-object-node");
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
-const { hasEffectorType } = require("../../utils/has-effector-type");
+const { nodeTypeIs } = require("../../utils/node-type-is");
 
 module.exports = {
   meta: {
@@ -30,11 +30,9 @@ module.exports = {
       'CallExpression[callee.property.name="watch"]'(node) {
         const object = traverseNestedObjectNode(node.callee?.object);
 
-        const isEffectorUnit = hasEffectorType({
+        const isEffectorUnit = nodeTypeIs.unit({
           node: object,
           context,
-          typeNames: ["Effect", "Event", "Store"],
-          useInitializer: false,
         });
 
         if (!isEffectorUnit) {

rules/strict-effect-handlers/examples/correct-only-async.js

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+async function f2() {}
+
+const finalFx = createEffect(async () => {
+  await f1();
+  await f2();
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/correct-only-fx.js

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+const oneFx = createEffect();
+const twoFx = createEffect();
+
+const finalFx = createEffect(async () => {
+  await oneFx();
+  await twoFx();
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/correct.ts

@@ -0,0 +1,34 @@
+import { createEffect } from "effector";
+
+const oneFx = createEffect();
+const twoFx = createEffect();
+
+const onlyEffectsFx = createEffect(async () => {
+  await oneFx(1);
+  await twoFx(1);
+});
+
+async function f1() {}
+async function f2() {}
+
+const onlyFunctionsFx = createEffect(async () => {
+  await f1();
+  await f2();
+});
+
+async function justFunctionWithEffects() {
+  await oneFx(1);
+  await twoFx(1);
+}
+
+async function justFunctionWithFunctions() {
+  await f1();
+  await f2();
+}
+
+export {
+  onlyEffectsFx,
+  onlyFunctionsFx,
+  justFunctionWithEffects,
+  justFunctionWithFunctions,
+};

rules/strict-effect-handlers/examples/incorrect-mix-async-fx-in-func.js

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async function () {
+  await f1();
+  await oneFx();
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/incorrect-mix-async-fx-in-func.ts

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async function () {
+  await f1();
+  await oneFx(1);
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/incorrect-mix-async-fx-in-named-func.js

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async function handler() {
+  await f1();
+  await oneFx();
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/incorrect-mix-async-fx-in-named-func.ts

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async function handler() {
+  await f1();
+  await oneFx(1);
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/incorrect-mix-async-fx.js

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async () => {
+  await f1();
+  await oneFx();
+});
+
+export { finalFx };

rules/strict-effect-handlers/examples/incorrect-mix-async-fx.ts

@@ -0,0 +1,11 @@
+import { createEffect } from "effector";
+
+async function f1() {}
+const oneFx = createEffect();
+
+const finalFx = createEffect(async () => {
+  await f1();
+  await oneFx(1);
+});
+
+export { finalFx };