Merge pull request #21 from plentific/kp/FEUIUX-315

FEUIUX-407 feat: add `no-deprecated-components` rule

.eslintrc.js

@@ -7,45 +7,54 @@ const noCyclicModulesImportsConfig = `
 `
 
 module.exports = {
-  extends: [
-    'plugin:eslint-comments/recommended',
-  ],
-  plugins: [
-    'plentific'
-  ],
+  extends: ["plugin:eslint-comments/recommended"],
+  plugins: ["plentific"],
 
   rules: {
-    'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
-    'eslint-comments/no-unused-disable': 'error',
-    'plentific/debug': 'error',
-    'plentific/no-concurrent-async': 'error',
-    'plentific/no-cyclic-modules-imports': ['error', { config: noCyclicModulesImportsConfig }],
-    'plentific/no-trailing-slash': 'error',
-    'plentific/no-window-location-replace': 'error',
+    "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
+    "eslint-comments/no-unused-disable": "error",
+    "plentific/debug": "error",
+    "plentific/no-concurrent-async": "error",
+    "plentific/no-deprecated-components": [
+      "error",
+      {
+        "examples/app/components/ComponentDeprecated":
+          "examples/app/components/Component",
+      },
+    ],
+    "plentific/no-cyclic-modules-imports": [
+      "error",
+      { config: noCyclicModulesImportsConfig },
+    ],
+    "plentific/no-trailing-slash": "error",
+    "plentific/no-window-location-replace": "error",
   },
 
-  overrides: [{
-    files: ['examples/**/*.js{x,}'],
-    parser: '@babel/eslint-parser',
-    parserOptions: {
-      ecmaFeatures: {
-        jsx: true,
-        legacyDecorators: true,
+  overrides: [
+    {
+      files: ["examples/**/*.js{x,}"],
+      parser: "@babel/eslint-parser",
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+          legacyDecorators: true,
+        },
+      },
+      rules: {
+        quotes: [2, "single"],
       },
     },
-    rules: {
-      quotes: [2, 'single']
-    }
-  }, {
-    files: ['examples/**/*.ts{x,}'],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-      ecmaFeatures: {
-        jsx: true,
+    {
+      files: ["examples/**/*.ts{x,}"],
+      parser: "@typescript-eslint/parser",
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+        ecmaVersion: 2018,
+        sourceType: "module",
+        project: "./tsconfig.json",
       },
-      ecmaVersion: 2018,
-      sourceType: 'module',
-      project: './tsconfig.json',
     },
-  }]
-}
+  ],
+};

examples/app/components/ComponentDeprecated/index.tsx

@@ -0,0 +1 @@
+export const ComponentDeprecated = () => null;

examples/app/modules/views/ExampleView.tsx

@@ -0,0 +1,4 @@
+// eslint-disable-next-line plentific/no-deprecated-components
+import { ComponentDeprecated } from "examples/app/components/ComponentDeprecated";
+
+export const ExampleView = () => <ComponentDeprecated />;

index.js

@@ -1,9 +1,10 @@
 module.exports = {
   rules: {
-    'debug': require('./rules/debug'),
-    'no-concurrent-async': require('./rules/no-concurrent-async'),
-    'no-cyclic-modules-imports': require('./rules/no-cyclic-modules-imports'),
-    'no-trailing-slash': require('./rules/no-trailing-slash'),
-    'no-window-location-replace': require('./rules/no-window-location-replace'),
-  }
-}
+    debug: require("./rules/debug"),
+    "no-concurrent-async": require("./rules/no-concurrent-async"),
+    "no-deprecated-components": require("./rules/no-deprecated-components"),
+    "no-cyclic-modules-imports": require("./rules/no-cyclic-modules-imports"),
+    "no-trailing-slash": require("./rules/no-trailing-slash"),
+    "no-window-location-replace": require("./rules/no-window-location-replace"),
+  },
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-plentific",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "main": "index.js",
   "author": "https://github.com/plentific/",
   "license": "UNLICENSED",

rules/no-deprecated-components.js

@@ -0,0 +1,40 @@
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Prevent importing deprecated component based on a configurable list of restricted paths.",
+    },
+    schema: [
+      {
+        type: "object",
+        additionalProperties: {
+          type: "string",
+        },
+      },
+    ],
+    messages: {
+      deprecatedComponentImport:
+        'Components and utils under "{{path}}" are considered deprecated, please migrate the usage to "{{replacement}}". If this rule is blocking you and you have to disable it, please include a comment with JIRA ticket and the reason for not doing the migration.',
+    },
+  },
+
+  create(context) {
+    const restrictedPaths = context.options[0] || {};
+
+    return {
+      ImportDeclaration(node) {
+        if (restrictedPaths.hasOwnProperty(node.source.value)) {
+          context.report({
+            node,
+            messageId: "deprecatedComponentImport",
+            data: {
+              path: node.source.value,
+              replacement: restrictedPaths[node.source.value],
+            },
+          });
+        }
+      },
+    };
+  },
+};