rule no-patronum-debug

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

config/patronum.js

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

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.json

@@ -32,6 +32,7 @@
     "glob": "^8.0.3",
     "jest": "^27.1.0",
     "nano-staged": "^0.5.0",
+    "patronum": "^1.12.1",
     "react": "^17.0.2",
     "simple-git-hooks": "^2.7.0",
     "typescript": "^4.4.2"

rules/no-patronum-debug/examples/correct.ts

@@ -0,0 +1,5 @@
+import { createStore } from "effector";
+const debug = (...args) => ({ ...args });
+debug({ test: "debug" });
+const $store = createStore({});
+debug({ store: $store });

rules/no-patronum-debug/examples/incorrect-with-debug-fork.ts

@@ -0,0 +1,6 @@
+import { fork, createStore } from "effector";
+import { debug } from "patronum";
+const $count = createStore(0);
+const scopeA = fork({ values: [[$count, 42]] });
+const scopeB = fork({ values: [[$count, 1337]] });
+debug.registerScope(scopeA, { name: "scope_42" });

rules/no-patronum-debug/examples/incorrect-with-debug.ts

@@ -0,0 +1,4 @@
+import { createStore } from "effector";
+import { debug } from "patronum";
+const $store = createStore({ fullname: "John Due" });
+debug($store);

rules/no-patronum-debug/examples/incorrect-with-import-alias.ts

@@ -0,0 +1,4 @@
+import { createEvent } from "effector";
+import { debug as debuggerPatronum } from "patronum";
+const event = createEvent();
+debuggerPatronum(event);

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);
+}

rules/no-patronum-debug/no-patronum-debug.md

@@ -0,0 +1,24 @@
+# effector/no-patronum-debug
+
+This rule will help to catch the forgotten `debug` and will automatically delete from code
+
+```js
+// from
+import { createStore, createEvent } from "effector";
+import { debug } from "patronum";
+
+const increment = createEvent();
+const $counter = createStore(0).on(increment, (count) => count + 1);
+
+debug($counter);
+```
+
+```js
+// to
+import { createStore, createEvent } from "effector";
+
+const increment = createEvent();
+const $counter = createStore(0).on(increment, (count) => count + 1);
+```
+
+`debug` are considered to be intended for debugging units from effector and therefore not suitable for sending to the client.