eslint-plugin-effector 0.14.0 → 0.15.0

package/config/scope.js

@@ -1,5 +1,6 @@
 module.exports = {
   rules: {
     "effector/strict-effect-handlers": "error",
+    "effector/require-pickup-in-persist": "error",
   },
 };

package/index.js

@@ -18,6 +18,7 @@ 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"),
+    "require-pickup-in-persist": require("./rules/require-pickup-in-persist/require-pickup-in-persist"),
     "no-patronum-debug": require("./rules/no-patronum-debug/no-patronum-debug"),
   },
   configs: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-effector",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Enforcing best practices for Effector",
   "keywords": [
     "eslint",
@@ -17,7 +17,7 @@
     "access": "public"
   },
   "engines": {
-    "node": "^16 || ^17 || ^18 || ^19 || ^20 || ^21"
+    "node": "^16 || ^17 || ^18 || ^19 || ^20 || ^21 || ^22"
   },
   "peerDependencies": {
     "effector": "^23",

package/rules/require-pickup-in-persist/require-pickup-in-persist.js

@@ -0,0 +1,47 @@
+const { createLinkToRule } = require("../../utils/create-link-to-rule");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      category: "Quality",
+      url: createLinkToRule("require-pickup-in-persist"),
+    },
+    messages: {
+      pickupMissing:
+        "This `persist` call does not specify a `pickup` event that is required for scoped usage of `effector-storage`.",
+    },
+    schema: [],
+  },
+  create(context) {
+    const pickupImports = new Set();
+
+    /**
+     * Finds `effector-storage` packages, scoped and unscoped, including
+     * contents of these packages. See examples for a full list.
+     */
+    const PACKAGE_NAME = /^@?effector-storage(\u002F[\w-]+)*$/;
+
+    const declarationSelector = `ImportDeclaration[source.value=${PACKAGE_NAME}]`;
+    const persistImportSelector = `ImportSpecifier[imported.name="persist"]`;
+
+    const configSelector = `[arguments.length=1][arguments.0.type="ObjectExpression"]`;
+    const callSelector = `[callee.type="Identifier"]`;
+
+    return {
+      [`${declarationSelector} > ${persistImportSelector}`](node) {
+        pickupImports.add(node.local.name);
+      },
+      [`CallExpression${configSelector}${callSelector}`](node) {
+        if (!pickupImports.has(node.callee.name)) return;
+
+        const config = node.arguments[0];
+
+        if (config.properties.some((prop) => prop.key?.name === "pickup"))
+          return;
+
+        context.report({ node, messageId: "pickupMissing" });
+      },
+    };
+  },
+};