eslint-plugin-restrict-replace-import 1.2.0 → 1.3.0

package/README.md

@@ -20,11 +20,11 @@ npm install eslint-plugin-restrict-replace-import --save-dev
 
 ## Usage
 
-Add `restrict-import` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+Add `restrict-replace-import` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
 ```json
 {
-  "plugins": ["restrict-import"]
+  "plugins": ["restrict-replace-import"]
 }
 ```
 
@@ -82,6 +82,40 @@ You can use RegExp for package name:
 }
 ```
 
+Is it possible as well to perform multiple partial replacements by setting and Object in the `replacement` property:
+
+```json
+{
+  "rules": {
+    "restrict-replace-import/restrict-import": [
+      "error",
+      [
+        {
+          "target": "with-partial-.*",
+          "replacement": {
+            "par(regExp)?tial-": "successfully-",
+            "repla(regExp)?cements": "replaced",
+            "with-": "",
+          }
+        }
+      ]
+    ]
+  }
+}
+```
+Given that rule configuration it will perform the following replacement:
+
+Input:
+```js
+import { useState } from 'with-partial-replacements'
+```
+
+Output:
+```js
+import { useState } from 'successfully-replaced'
+```
+
+
 ## Rules
 
 <!-- begin auto-generated rules list -->

package/docs/rules/restrict-import.md

@@ -1,4 +1,4 @@
-# Prevent the Import of a Specific Package (`restrict-import/restrict-import`)
+# Prevent the Import of a Specific Package (`restrict-replace-import/restrict-import`)
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
@@ -19,7 +19,7 @@ Example configuration:
 ```json
 {
   "rules": {
-    "restrict-import/restrict-import": [
+    "restrict-replace-import/restrict-import": [
       "error",
       [
         {

package/lib/rules/restrict-import.js

@@ -25,31 +25,47 @@ module.exports = {
 
     schema: {
       type: "array",
+      maxLength: 1,
+      minLength: 1,
       items: {
-        anyOf: [
-          {
-            type: "string",
-          },
-          {
-            type: "object",
-            properties: {
-              target: {
-                type: "string",
-              },
-              replacement: {
-                type: "string",
+        type: "array",
+        items: {
+          oneOf: [
+            {
+              type: "string",
+            },
+            {
+              type: "object",
+              properties: {
+                target: {
+                  type: "string",
+                },
+                replacement: {
+                  oneOf: [
+                    { type: "string" },
+                    { 
+                      type: "object", 
+                      patternProperties: {
+                        ".*": { type: "string" }
+                      }
+                    }
+                  ]
+                },
               },
+              required: ["target"],
+              additionalProperties: false,
             },
-          },
-        ],
+          ],
+        },
       },
     },
   },
 
   create(context) {
     const restrictedPackages = new Map();
+    const restrictedPackagesOption = context.options[0];
 
-    context.options.forEach((packageName) => {
+    restrictedPackagesOption.forEach((packageName) => {
       if (typeof packageName === "string") {
         restrictedPackages.set(
           new RegExp(`^${packageName}$`),
@@ -111,7 +127,7 @@ module.exports = {
 
         context.report({
           node,
-          messageId: replacement
+          messageId: typeof replacement === "string"
             ? "ImportRestrictionWithReplacement"
             : "ImportRestriction",
           data: {
@@ -123,10 +139,26 @@ module.exports = {
               return;
             }
 
-            return fixer.replaceText(
-              node.source,
-              `${quote}${replacement}${quote}`
-            );
+            if (typeof replacement === "string") {
+              return fixer.replaceText(
+                node.source,
+                `${quote}${replacement}${quote}`
+              );
+            }
+
+            if (typeof replacement === "object") {
+              let partiallyReplaced = node.source.value;
+              for (const [key, value] of Object.entries(replacement)) {
+                const regex = new RegExp(key, 'g');
+                partiallyReplaced = partiallyReplaced.replace(regex, value);
+              }
+              return fixer.replaceText(
+                node.source,
+                `${quote}${partiallyReplaced}${quote}`
+              );
+            }
+
+            return null;
           },
         });
       },

package/package.json

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