eslint-plugin-effector 0.8.0 → 0.9.0

package/README.md

@@ -89,6 +89,12 @@ This preset contains rules, which enforce _future-effector_ code-style.
 - [effector/no-forward](rules/no-forward/no-forward.md)
 - [effector/no-guard](rules/no-guard/no-guard.md)
 
+#### plugin:effector/patronum
+
+This preset is recommended for projects that use [Patronum](https://patronum.effector.dev/).
+
+- [effector/no-patronum-debug](rules/no-patronum-debug/no-patronum-debug.md)
+
 ## Maintenance
 
 ### Release flow

package/config/patronum.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    "effector/no-patronum-debug": "error",
+  },
+};

package/config/react.js

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

package/index.js

@@ -17,11 +17,13 @@ module.exports = {
     "no-guard": require("./rules/no-guard/no-guard"),
     "mandatory-scope-binding": require("./rules/mandatory-scope-binding/mandatory-scope-binding"),
     "prefer-useUnit": require("./rules/prefer-useUnit/prefer-useUnit"),
+    "no-patronum-debug": require("./rules/no-patronum-debug/no-patronum-debug"),
   },
   configs: {
     recommended: require("./config/recommended"),
     scope: require("./config/scope"),
     react: require("./config/react"),
     future: require("./config/future"),
+    patronum: require("./config/patronum"),
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-effector",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "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/no-patronum-debug/no-patronum-debug.js

@@ -0,0 +1,126 @@
+const { createLinkToRule } = require("../../utils/create-link-to-rule");
+const { extractImportedFrom } = require("../../utils/extract-imported-from");
+
+module.exports = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Disallow the use of patronum `debug`",
+      category: "Quality",
+      recommended: false,
+      url: createLinkToRule("no-patronum-debug"),
+    },
+    messages: {
+      noPatronumDebug: "Unexpected patronum `debug` statement",
+      removePatronumDebug: "Remove this `debug` from patronum",
+    },
+    schema: [],
+    hasSuggestions: true,
+  },
+  create(context) {
+    const importedFromPatronum = new Map();
+    const importNodes = new Map();
+
+    return {
+      ImportDeclaration(node) {
+        extractImportedFrom({
+          packageName: ["patronum", "patronum/debug"],
+          importMap: importedFromPatronum,
+          nodeMap: importNodes,
+          node,
+        });
+      },
+      CallExpression(node) {
+        const currentMethodName = node.callee?.name ?? node.callee?.object.name;
+        const importedDebugFromPatronum = importedFromPatronum.get("debug");
+
+        if (currentMethodName !== importedDebugFromPatronum) {
+          return;
+        }
+
+        context.report({
+          messageId: "noPatronumDebug",
+          node,
+          suggest: [
+            {
+              messageId: "removePatronumDebug",
+              *fix(fixer) {
+                yield* removeDebugFromPatronum({
+                  fixer,
+                  node,
+                  context,
+                  importNodes,
+                });
+              },
+            },
+          ],
+        });
+      },
+    };
+  },
+};
+
+function* removeDebugFromPatronum({
+  fixer,
+  node,
+  context,
+  importNodes,
+  targetMethod = "debug",
+}) {
+  const sourceCode = context.getSourceCode();
+  const startToken = sourceCode.getTokenBefore(node);
+
+  // remove line with debug
+  yield fixer.removeRange([startToken.range[1], node.range[1] + 1]);
+
+  const importDebugNode = importNodes.get(targetMethod);
+
+  if (!importDebugNode) {
+    return null;
+  }
+
+  // remove import with debug
+  const importParentNode = importDebugNode.parent;
+
+  /**
+   * import { debug } from 'patronum'
+   * import { debug } from 'patronum/debug'
+   */
+  if (importParentNode.specifiers.length === 1) {
+    yield fixer.removeRange([
+      importParentNode.range[0],
+      importParentNode.range[1] + 1,
+    ]);
+
+    return null;
+  }
+
+  const amountImportFromPatronum = importParentNode.specifiers.length;
+  const importLast = importParentNode.specifiers[amountImportFromPatronum - 1];
+
+  const filterTokenComma = { filter: (token) => token.value === "," };
+
+  /**
+   * import { debug, timeout } from 'patronum'
+   * import { condition, debug, throttle } from 'patronum'
+   */
+  if (importDebugNode !== importLast) {
+    const prevNode = sourceCode.getTokenBefore(importDebugNode);
+    const comma = sourceCode.getTokenAfter(importDebugNode, filterTokenComma);
+
+    yield fixer.removeRange([prevNode.range[1], importDebugNode.range[0]]);
+    yield fixer.remove(importDebugNode);
+    yield fixer.remove(comma);
+
+    return null;
+  }
+
+  /**
+   * import { condition, debug } from 'patronum'
+   */
+  const comma = sourceCode.getTokenBefore(importDebugNode, filterTokenComma);
+
+  yield fixer.removeRange([comma.range[1], importDebugNode.range[0]]);
+  yield fixer.remove(importDebugNode);
+  yield fixer.remove(comma);
+}

package/rules/no-watch/no-watch.js

@@ -15,7 +15,7 @@ module.exports = {
     },
     messages: {
       abusiveCall:
-        "Method `.watch` leads to imperative code. Try to replace it with operators (`sample`, `guard`, etc) or use the `target` parameter of the operators.",
+        "Method `.watch` leads to imperative code. Try to replace it with operator (`sample`) or use the `target` parameter of the operator.",
     },
     schema: [],
   },

package/utils/extract-imported-from.js

@@ -1,5 +1,9 @@
 function extractImportedFrom({ importMap, nodeMap, node, packageName }) {
-  if (node.source.value === packageName) {
+  const normalizePackageName = Array.isArray(packageName)
+    ? packageName
+    : [packageName];
+
+  if (normalizePackageName.includes(node.source.value)) {
     for (const s of node.specifiers) {
       if (s.type === "ImportDefaultSpecifier") {
         continue;