rule prefer-scope-imports

docs/rules/prefer-scope-imports.md

@@ -0,0 +1,34 @@
+# effector/no-scope-imports
+
+This rule prefers scoped namespace imports.
+
+Works with `effector-react`, `effector-solid`by default.
+
+```js
+// from
+import { useUnit, useList } from "effector-react";
+```
+
+---
+
+```js
+// to
+import { useUnit, useList } from "effector-react/scope";
+```
+
+You can also provide extra packages to include.
+
+```json
+{
+  "effector/prefer-scope-imports": [
+    "error",
+    {
+      "packages": ["@effector/reflect", "@farfetched/core", "another-lib"]
+    }
+  ]
+}
+```
+
+```js
+import { stuff } from "@effector/reflect/scope";
+```

index.js

@@ -18,6 +18,7 @@ module.exports = {
     "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"),
+    "prefer-scope-imports": require("./rules/prefer-scope-imports/prefer-scope-imports"),
   },
   configs: {
     recommended: require("./config/recommended"),

rules/prefer-scope-imports/examples/correct.js

@@ -0,0 +1 @@
+import { useUnit, useList } from "effector-react/scope";

rules/prefer-scope-imports/examples/incorrect.js

@@ -0,0 +1 @@
+import { useUnit, useList } from "effector-react";

rules/prefer-scope-imports/prefer-scope-imports.js

@@ -0,0 +1,60 @@
+const { createLinkToRule } = require("../../utils/create-link-to-rule");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Prefer scoped namespace imports",
+      category: "Quality",
+      recommended: true,
+      url: createLinkToRule("prefer-scope-imports"),
+    },
+    messages: {
+      preferScope: "Use the `/scope` namespace.",
+    },
+    schema: [
+      {
+        type: "object",
+        properties: {
+          packages: {
+            type: "array",
+            minItems: 0,
+            items: [
+              {
+                type: "string",
+              },
+            ],
+          },
+        },
+      },
+    ],
+    hasSuggestions: true,
+    fixable: "code",
+  },
+  create(context) {
+    const options = context.options[0];
+    const userPackages = options?.packages ?? [];
+
+    const packages = ["effector-react", "effector-solid", ...userPackages];
+
+    return {
+      ImportDeclaration(node) {
+        if (!packages.includes(node.source.value)) return;
+
+        context.report({
+          node,
+          messageId: "preferScope",
+          suggest: [
+            {
+              messageId: "preferScope",
+              fix(fixer) {
+                const literal = node.source;
+                return fixer.replaceText(literal, `'${literal.value}/scope'`);
+              },
+            },
+          ],
+        });
+      },
+    };
+  },
+};

rules/prefer-scope-imports/prefer-scope-imports.md

@@ -0,0 +1 @@
+https://eslint.effector.dev/rules/prefer-scope-imports.html

rules/prefer-scope-imports/prefer-scope-imports.test.js

@@ -0,0 +1,84 @@
+const { RuleTester } = require("eslint");
+const { join } = require("path");
+
+const { readExample } = require("../../utils/read-example");
+const rule = require("./prefer-scope-imports");
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+  },
+});
+
+const readExampleForTheRule = (name) => ({
+  code: readExample(__dirname, name),
+  filename: join(__dirname, "examples", name),
+});
+
+ruleTester.run("effector/prefer-scope-imports.test", rule, {
+  valid: [
+    ...["correct.js"].map(readExampleForTheRule),
+    ...["import { useUnit, useList } from 'effector-solid/scope';"].map(
+      (code) => ({ code })
+    ),
+    {
+      code: "import { useUnit, useList } from '@farfetched/core';",
+    },
+    {
+      code: "import { useUnit, useList } from 'effector-react/core';",
+    },
+  ],
+
+  invalid: [
+    ...["incorrect.js"].map(readExampleForTheRule).map((result) => ({
+      ...result,
+      errors: [
+        {
+          messageId: "preferScope",
+          type: "ImportDeclaration",
+          suggestions: [
+            {
+              messageId: "preferScope",
+              output:
+                "import { useUnit, useList } from 'effector-react/scope';",
+            },
+          ],
+        },
+      ],
+    })),
+    {
+      code: "import { useUnit, useList } from '@farfetched/core';",
+      options: [{ packages: ["@farfetched/core"] }],
+      errors: [
+        {
+          messageId: "preferScope",
+          type: "ImportDeclaration",
+          suggestions: [
+            {
+              messageId: "preferScope",
+              output:
+                "import { useUnit, useList } from '@farfetched/core/scope';",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      code: "import { useUnit, useList } from 'effector-solid';",
+      errors: [
+        {
+          messageId: "preferScope",
+          type: "ImportDeclaration",
+          suggestions: [
+            {
+              messageId: "preferScope",
+              output:
+                "import { useUnit, useList } from 'effector-solid/scope';",
+            },
+          ],
+        },
+      ],
+    },
+  ],
+});