eslint-plugin-restrict-replace-import 1.0.0

package/.eslintrc.js

@@ -0,0 +1,19 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: ["tests/**/*.js"],
+      env: { mocha: true },
+    },
+  ],
+};

package/README.md

@@ -0,0 +1,76 @@
+# eslint-plugin-restrict-replace-import
+
+ESLint Plugin for Restricting and Replacing Import.
+
+Automatically fixable with replacement package!
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-restrict-replace-import`:
+
+```sh
+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:
+
+```json
+{
+  "plugins": ["restrict-import"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "restrict-import/rule-name": [
+      "error",
+      ["restricted-package1", "restricted-package2"]
+    ]
+  }
+}
+```
+
+You can also specify an alternative package to import instead:
+
+```json
+{
+  "rules": {
+    "restrict-import/rule-name": [
+      "error",
+      [
+        {
+          "name": "restricted-package1",
+          "alternative": "replacement-package1"
+        },
+        {
+          "name": "restricted-package2",
+          "alternative": "replacement-package2"
+        }
+      ]
+    ]
+  }
+}
+```
+
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                             | Description                              | 🔧  |
+| :----------------------------------------------- | :--------------------------------------- | :-- |
+| [restrict-import](docs/rules/restrict-import.md) | Prevent the Import of a Specific Package | 🔧  |
+
+<!-- end auto-generated rules list -->

package/docs/rules/restrict-import.md

@@ -0,0 +1,71 @@
+# Prevent the Import of a Specific Package (`restrict-import/restrict-import`)
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+This rule aims to prevent the import of a specific package.
+
+With additional configuration, this rule can also suggest an alternative package to import instead.
+
+If the alternative package is specified, auto-fixing will replace the import statement with the alternative package.
+
+## Rule Details
+
+Example configuration:
+
+```json
+{
+  "rules": {
+    "restrict-import/restrict-import": [
+      "error",
+      [
+        {
+          "name": "test-package",
+          "alternative": "replacement-package"
+        },
+        "another-package"
+      ]
+    ]
+  }
+}
+```
+
+Examples of **incorrect** code for this rule:
+
+```js
+import testPackage from "test-package";
+
+import anotherPackage from "another-package";
+```
+
+Examples of **correct** code for this rule:
+
+```js
+import testPackage from "replacement-package";
+
+import theOtherPackage from "the-other-package";
+```
+
+### Options
+
+This rule takes a single argument, an array of strings or objects.
+
+Each string or object represents a package that should be restricted.
+
+If the array element is a string, it represents the name of the package that should be restricted.
+
+If the array element is an object, it represents the name of the package that should be restricted and the alternative package that should be suggested instead.
+
+The alternative package is optional.
+
+Scheme:
+
+```ts
+type Restriction =
+  | string
+  | {
+      target: string;
+      replacement?: string;
+    };
+```

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview ESLint Plugin for Restricting Import
+ * @author shiwoo.park
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/restrict-import.js

@@ -0,0 +1,133 @@
+/**
+ * @fileoverview Prevent the Import of a Specific Package
+ * @author shiwoo.park
+ */
+"use strict";
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Prevent the Import of a Specific Package",
+      recommended: false,
+      url: "https://github.com/custardcream98/eslint-plugin-restrict-replace-import/blob/main/docs/rules/restrict-import.md",
+    },
+    fixable: "code",
+
+    messages: {
+      ImportRestriction:
+        "`{{ name }}` is restricted from being used.",
+      ImportRestrictionWithReplacement:
+        "`{{ name }}` is restricted from being used. Replace it with `{{ replacement }}`.",
+    },
+
+    schema: [
+      {
+        type: "object",
+        properties: {
+          restrictedPackages: {
+            type: "array",
+            items: {
+              anyOf: [
+                {
+                  type: "string",
+                },
+                {
+                  type: "object",
+                  properties: {
+                    target: {
+                      type: "string",
+                      required: true,
+                    },
+                    replacement: {
+                      type: "string",
+                      required: false,
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        },
+      },
+    ],
+  },
+
+  create(context) {
+    const option = context.options[0];
+
+    const restrictedPackages = new Map();
+
+    option.restrictedPackages.forEach((packageName) => {
+      if (typeof packageName === "string") {
+        restrictedPackages.set(packageName, null);
+        return;
+      }
+
+      restrictedPackages.set(
+        packageName.target,
+        packageName.replacement
+          ? packageName.replacement
+          : null
+      );
+    });
+
+    const checkRestricted = (importSource) => {
+      const isRestricted =
+        restrictedPackages.has(importSource);
+
+      return isRestricted;
+    };
+
+    const getReplacement = (importSource) => {
+      const replacement =
+        restrictedPackages.get(importSource);
+
+      return replacement;
+    };
+
+    return {
+      ImportDeclaration(node) {
+        const importSource = node.source.value;
+        const importSourceType = node.source.type;
+
+        const isRestricted = checkRestricted(importSource);
+
+        if (
+          !isRestricted ||
+          importSourceType !== "Literal"
+        ) {
+          return;
+        }
+
+        const replacement = getReplacement(importSource);
+        const quote = node.source.raw.includes("'")
+          ? "'"
+          : '"';
+
+        context.report({
+          node,
+          messageId: replacement
+            ? "ImportRestrictionWithReplacement"
+            : "ImportRestriction",
+          data: {
+            name: importSource,
+            replacement,
+          },
+          fix: (fixer) => {
+            if (!replacement) {
+              return;
+            }
+
+            return fixer.replaceText(
+              node.source,
+              `${quote}${replacement}${quote}`
+            );
+          },
+        });
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "eslint-plugin-restrict-replace-import",
+  "version": "1.0.0",
+  "description": "ESLint Plugin for Restricting and Replacing Import",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "import",
+    "restrict"
+  ],
+  "author": "shiwoo.park",
+  "bugs": {
+    "url": "https://github.com/custardcream98/eslint-plugin-restrict-replace-import/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/custardcream98/eslint-plugin-restrict-replace-import.git"
+  },
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint .",
+    "test": "mocha tests --recursive",
+    "update:eslint-docs": "eslint-doc-generator"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-doc-generator": "^1.0.0",
+    "eslint-plugin-eslint-plugin": "^5.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^10.0.0",
+    "npm-run-all": "^4.1.5"
+  },
+  "engines": {
+    "node": "^14.17.0 || ^16.0.0 || >= 18.0.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=7"
+  },
+  "license": "ISC"
+}

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

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview Prevent the Import of a Specific Package
+ * @author shiwoo.park
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/restrict-import"),
+  RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2015,
+    sourceType: "module",
+  },
+});
+
+const OPTIONS = [
+  {
+    restrictedPackages: [
+      "lodash",
+      {
+        target: "react",
+        replacement: "preact",
+      },
+    ],
+  },
+];
+
+ruleTester.run("restrict-import", rule, {
+  valid: [
+    {
+      code: "import _ from 'underscore'",
+      options: OPTIONS,
+    },
+    {
+      code: "import _ from 'lodash-es'",
+      options: OPTIONS,
+    },
+    {
+      code: "import { useState } from 'preact'",
+      options: OPTIONS,
+    },
+  ],
+
+  invalid: [
+    {
+      code: "import _ from 'lodash'",
+      errors: [
+        {
+          message:
+            "`lodash` is restricted from being used.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output: null,
+    },
+    {
+      code: "import { useState } from 'react'",
+      errors: [
+        {
+          message:
+            "`react` is restricted from being used. Replace it with `preact`.",
+          type: "ImportDeclaration",
+        },
+      ],
+      options: OPTIONS,
+      output: "import { useState } from 'preact'",
+    },
+  ],
+});