eslint-plugin-restrict-replace-import 1.0.0 → 1.1.0

package/docs/rules/restrict-import.md

@@ -10,6 +10,8 @@ With additional configuration, this rule can also suggest an alternative package
 
 If the alternative package is specified, auto-fixing will replace the import statement with the alternative package.
 
+You can use RegExp to match multiple packages.
+
 ## Rule Details
 
 Example configuration:
@@ -25,21 +27,25 @@ Example configuration:
           "alternative": "replacement-package"
         },
         "another-package"
+        "with(?:-regex)?-support"
       ]
     ]
   }
 }
 ```
 
-Examples of **incorrect** code for this rule:
+Examples of **incorrect** code for this rule with options above:
 
 ```js
 import testPackage from "test-package";
 
 import anotherPackage from "another-package";
+
+import withRegexSupport from "with-regex-support";
+import withSupport from "with-support";
 ```
 
-Examples of **correct** code for this rule:
+Examples of **correct** code for this rule with options above:
 
 ```js
 import testPackage from "replacement-package";

package/lib/rules/restrict-import.js

@@ -26,6 +26,7 @@ module.exports = {
     schema: [
       {
         type: "object",
+        additionalProperties: false,
         properties: {
           restrictedPackages: {
             type: "array",
@@ -39,11 +40,9 @@ module.exports = {
                   properties: {
                     target: {
                       type: "string",
-                      required: true,
                     },
                     replacement: {
                       type: "string",
-                      required: false,
                     },
                   },
                 },
@@ -62,12 +61,15 @@ module.exports = {
 
     option.restrictedPackages.forEach((packageName) => {
       if (typeof packageName === "string") {
-        restrictedPackages.set(packageName, null);
+        restrictedPackages.set(
+          new RegExp(`^${packageName}$`),
+          null
+        );
         return;
       }
 
       restrictedPackages.set(
-        packageName.target,
+        new RegExp(`^${packageName.target}$`),
         packageName.replacement
           ? packageName.replacement
           : null
@@ -75,15 +77,22 @@ module.exports = {
     });
 
     const checkRestricted = (importSource) => {
-      const isRestricted =
-        restrictedPackages.has(importSource);
-
-      return isRestricted;
+      const restrictedRegExp = Array.from(
+        restrictedPackages.keys()
+      ).find((packageName) => {
+        return packageName.test(importSource);
+      });
+
+      return {
+        isRestricted: !!restrictedRegExp,
+        restrictedRegExp,
+      };
     };
 
-    const getReplacement = (importSource) => {
-      const replacement =
-        restrictedPackages.get(importSource);
+    const getReplacement = (restrictedRegExp) => {
+      const replacement = restrictedPackages.get(
+        restrictedRegExp
+      );
 
       return replacement;
     };
@@ -93,7 +102,8 @@ module.exports = {
         const importSource = node.source.value;
         const importSourceType = node.source.type;
 
-        const isRestricted = checkRestricted(importSource);
+        const { isRestricted, restrictedRegExp } =
+          checkRestricted(importSource);
 
         if (
           !isRestricted ||
@@ -102,7 +112,9 @@ module.exports = {
           return;
         }
 
-        const replacement = getReplacement(importSource);
+        const replacement = getReplacement(
+          restrictedRegExp
+        );
         const quote = node.source.raw.includes("'")
           ? "'"
           : '"';
@@ -113,7 +125,7 @@ module.exports = {
             ? "ImportRestrictionWithReplacement"
             : "ImportRestriction",
           data: {
-            name: importSource,
+            name: restrictedRegExp.toString().slice(2, -2),
             replacement,
           },
           fix: (fixer) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-restrict-replace-import",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "ESLint Plugin for Restricting and Replacing Import",
   "keywords": [
     "eslint",

package/tests/lib/rules/restrict-import.js

@@ -30,6 +30,15 @@ const OPTIONS = [
         target: "react",
         replacement: "preact",
       },
+      {
+        target: "any-other-with(?:regex)",
+        replacement: "any-other-replacement",
+      },
+      "other-with(?:regex)",
+      {
+        target: "with(?:-regex)?-support",
+        replacement: "with-support-replacement",
+      },
     ],
   },
 ];
@@ -75,5 +84,56 @@ ruleTester.run("restrict-import", rule, {
       options: OPTIONS,
       output: "import { useState } from 'preact'",
     },
+    {
+      code: "import { useState } from 'any-other-withregex'",
+      errors: [
+        {
+          message:
+            "`any-other-with(?:regex)` is restricted from being used. Replace it with `any-other-replacement`.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output:
+        "import { useState } from 'any-other-replacement'",
+    },
+    {
+      code: "import { useState } from 'other-withregex'",
+      errors: [
+        {
+          message:
+            "`other-with(?:regex)` is restricted from being used.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output: null,
+    },
+    {
+      code: "import { useState } from 'with-regex-support'",
+      errors: [
+        {
+          message:
+            "`with(?:-regex)?-support` is restricted from being used. Replace it with `with-support-replacement`.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output:
+        "import { useState } from 'with-support-replacement'",
+    },
+    {
+      code: "import { useState } from 'with-support'",
+      errors: [
+        {
+          message:
+            "`with(?:-regex)?-support` is restricted from being used. Replace it with `with-support-replacement`.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output:
+        "import { useState } from 'with-support-replacement'",
+    },
   ],
 });