eslint-plugin-effector 0.7.6 → 0.8.2

package/README.md

@@ -79,7 +79,8 @@ This preset is recommended for projects that use [Fork API](https://effector.dev
 This preset is recommended for projects that use [React](https://reactjs.org) with Effector.
 
 - [effector/enforce-gate-naming-convention](rules/enforce-gate-naming-convention/enforce-gate-naming-convention.md)
-- [effector/mandatory-useEvent](rules/mandatory-useEvent/mandatory-useEvent.md)
+- [effector/mandatory-scope-binding](rules/mandatory-scope-binding/mandatory-scope-binding.md)
+- [effector/prefer-useUnit](rules/prefer-useUnit/prefer-useUnit.md)
 
 #### plugin:effector/future
 

package/config/react.js

@@ -1,6 +1,7 @@
 module.exports = {
   rules: {
     "effector/enforce-gate-naming-convention": "error",
-    "effector/mandatory-useEvent": "error",
+    "effector/mandatory-scope-binding": "error",
+    "effector/prefer-useUnit": "warn",
   },
 };

package/index.js

@@ -15,7 +15,8 @@ module.exports = {
     "keep-options-order": require("./rules/keep-options-order/keep-options-order"),
     "no-forward": require("./rules/no-forward/no-forward"),
     "no-guard": require("./rules/no-guard/no-guard"),
-    "mandatory-useEvent": require("./rules/mandatory-useEvent/mandatory-useEvent"),
+    "mandatory-scope-binding": require("./rules/mandatory-scope-binding/mandatory-scope-binding"),
+    "prefer-useUnit": require("./rules/prefer-useUnit/prefer-useUnit"),
   },
   configs: {
     recommended: require("./config/recommended"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-effector",
-  "version": "0.7.6",
+  "version": "0.8.2",
   "description": "Enforcing best practices for Effector",
   "keywords": [
     "eslint",

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

@@ -11,6 +11,7 @@ const {
 } = require("../../utils/get-corrected-store-name");
 const { createLinkToRule } = require("../../utils/create-link-to-rule");
 const { nodeTypeIs } = require("../../utils/node-type-is");
+const { traverseParentByType } = require("../../utils/traverse-parent-by-type");
 
 module.exports = {
   meta: {
@@ -75,31 +76,31 @@ module.exports = {
         // Store creation with method
         const STORE_CREATION_METHODS = ["createStore", "restore", "combine"];
         for (const method of STORE_CREATION_METHODS) {
-          const localMethod = importedFromEffector.get(method);
+          const localMethod = importedFromEffector.get(method);          
           if (!localMethod) {
             continue;
           }
-
+            
           const isEffectorStoreCreation = node.callee.name === localMethod;
           if (!isEffectorStoreCreation) {
             continue;
           }
 
-          const resultSavedInVariable =
-            node.parent.type === "VariableDeclarator";
+          const parentNode = traverseParentByType(node, "VariableDeclarator", ["Program"]);
+
+          const resultSavedInVariable = parentNode.type === "VariableDeclarator";
           if (!resultSavedInVariable) {
             continue;
           }
 
-          const storeName = node.parent.id.name;
-
+          const storeName = parentNode.id.name;
           if (namingOf.store.isValid({ name: storeName, context })) {
             continue;
           }
 
           reportStoreNameConventionViolation({
             context,
-            node: node.parent,
+            node: parentNode,
             storeName,
           });
           return;
@@ -115,8 +116,8 @@ module.exports = {
             return;
           }
 
-          const resultSavedInVariable =
-            node.parent.type === "VariableDeclarator";
+          const resultSavedInVariable = node.parent.type === "VariableDeclarator";
+
           if (!resultSavedInVariable) {
             return;
           }
@@ -140,13 +141,15 @@ module.exports = {
         if (
           STORE_IN_DOMAIN_CREATION_METHODS.includes(node.callee?.property?.name)
         ) {
-          const resultSavedInVariable =
-            node.parent.type === "VariableDeclarator";
+
+          const parentNode = traverseParentByType(node, "VariableDeclarator", ["Program"]);
+
+          const resultSavedInVariable = parentNode.type === "VariableDeclarator";
           if (!resultSavedInVariable) {
             return;
           }
 
-          const storeName = node.parent.id.name;
+          const storeName = parentNode.id.name;
 
           if (namingOf.store.isValid({ name: storeName, context })) {
             return;
@@ -154,7 +157,7 @@ module.exports = {
 
           reportStoreNameConventionViolation({
             context,
-            node: node.parent,
+            node: parentNode,
             storeName,
           });
           return;

package/rules/{mandatory-useEvent/mandatory-useEvent.js → mandatory-scope-binding/mandatory-scope-binding.js}

@@ -9,14 +9,14 @@ module.exports = {
     type: "problem",
     docs: {
       description:
-        "Forbids `Event` and `Effect` usage without `useEvent` in React components.",
+        "Forbids `Event` and `Effect` usage without `useUnit` in React components.",
       category: "Quality",
       recommended: true,
-      url: createLinkToRule("mandatory-useEvent"),
+      url: createLinkToRule("mandatory-scope-binding"),
     },
     messages: {
       useEventNeeded:
-        "{{ unitName }} must be wrapped with `useEvent` from `effector-react` before usage inside React components",
+        "{{ unitName }} must be wrapped with `useUnit` from `effector-react` before usage inside React components",
     },
     schema: [],
   },

package/rules/prefer-useUnit/prefer-useUnit.js

@@ -0,0 +1,56 @@
+const { createLinkToRule } = require("../../utils/create-link-to-rule");
+const { extractImportedFrom } = require("../../utils/extract-imported-from");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Suggests to replace old hooks `useStore`/`useEvent` by the new one `useUnit`",
+      category: "Quality",
+      recommended: true,
+      url: createLinkToRule("prefer-useUnit"),
+    },
+    messages: {
+      useUnitNeeded: "`{{ hookName }}` could be replaced by `useUnit`",
+    },
+    schema: [],
+  },
+  create(context) {
+    const importedFromEffectorReact = new Map();
+
+    return {
+      ImportDeclaration(node) {
+        extractImportedFrom({
+          importMap: importedFromEffectorReact,
+          packageName: "effector-react",
+          node,
+        });
+      },
+      CallExpression(node) {
+        const OLD_HOOKS = ["useStore", "useEvent"];
+        const NEW_HOOK = ["useUnit"];
+
+        for (const oldHookName of OLD_HOOKS) {
+          const localOldHookName = importedFromEffectorReact.get(oldHookName);
+          if (!localOldHookName) {
+            continue;
+          }
+
+          const isOldHook = node.callee.name === localOldHookName;
+          if (!isOldHook) {
+            continue;
+          }
+
+          context.report({
+            node,
+            messageId: "useUnitNeeded",
+            data: {
+              hookName: oldHookName,
+            },
+          });
+        }
+      },
+    };
+  },
+};