feat: data-codemods cleanup rule

packages/eslint-plugin-pf-codemods/src/ruleCustomization.ts

@@ -69,6 +69,7 @@ export const setupRules = [
 
 // rules that will run after other rules (cleanup imports?)
 export const cleanupRules = [
+  "data-codemods-cleanup",
   "no-unused-imports-v5",
   "no-unused-imports-v6",
   "no-duplicate-import-specifiers",

packages/eslint-plugin-pf-codemods/src/rules/v6/dataCodemodsCleanup/data-codemods-cleanup.md

@@ -0,0 +1,18 @@
+### data-codemods-cleanup
+
+This rule will remove `data-codemods` attributes and comments, which were introduced by our codemods in order to work correctly.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
+

packages/eslint-plugin-pf-codemods/src/rules/v6/dataCodemodsCleanup/data-codemods-cleanup.test.ts

@@ -0,0 +1,90 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./data-codemods-cleanup";
+
+const message = `This rule will remove data-codemods attributes and comments, which were introduced by our codemods in order to work correctly.`;
+
+ruleTester.run("data-codemods-cleanup", rule, {
+  valid: [
+    {
+      code: `import { DualListSelector /* data-codemods */ } from 'somewhereElse';`,
+    },
+    {
+      code: `import { LoginMainFooterLinksItem } from 'somewhereElse'; <LoginMainFooterLinksItem data-codemods="true" />`,
+    },
+  ],
+  invalid: [
+    {
+      code: `import { DualListSelector /* data-codemods */ } from '@patternfly/react-core';`,
+      output: `import { DualListSelector  } from '@patternfly/react-core';`,
+      errors: [
+        {
+          message,
+          type: "ImportSpecifier",
+        },
+      ],
+    },
+    // aliased import
+    {
+      code: `import { DualListSelector as DLS /* data-codemods */ } from '@patternfly/react-core';`,
+      output: `import { DualListSelector as DLS  } from '@patternfly/react-core';`,
+      errors: [
+        {
+          message,
+          type: "ImportSpecifier",
+        },
+      ],
+    },
+    {
+      code: `import { LoginMainFooterLinksItem } from '@patternfly/react-core'; <LoginMainFooterLinksItem data-codemods="true" />`,
+      output: `import { LoginMainFooterLinksItem } from '@patternfly/react-core'; <LoginMainFooterLinksItem  />`,
+      errors: [
+        {
+          message,
+          type: "JSXOpeningElement",
+        },
+      ],
+    },
+    {
+      code: `import { MastheadLogo } from '@patternfly/react-core'; <MastheadLogo data-codemods />`,
+      output: `import { MastheadLogo } from '@patternfly/react-core'; <MastheadLogo  />`,
+      errors: [
+        {
+          message,
+          type: "JSXOpeningElement",
+        },
+      ],
+    },
+    // dist imports
+    {
+      code: `import { MastheadLogo } from '@patternfly/react-core/dist/esm/components/MastheadLogo'; <MastheadLogo data-codemods />`,
+      output: `import { MastheadLogo } from '@patternfly/react-core/dist/esm/components/MastheadLogo'; <MastheadLogo  />`,
+      errors: [
+        {
+          message,
+          type: "JSXOpeningElement",
+        },
+      ],
+    },
+    {
+      code: `import { MastheadLogo } from '@patternfly/react-core/dist/js/components/MastheadLogo'; <MastheadLogo data-codemods />`,
+      output: `import { MastheadLogo } from '@patternfly/react-core/dist/js/components/MastheadLogo'; <MastheadLogo  />`,
+      errors: [
+        {
+          message,
+          type: "JSXOpeningElement",
+        },
+      ],
+    },
+    // with alias
+    {
+      code: `import { MastheadLogo as ML } from '@patternfly/react-core'; <ML data-codemods />`,
+      output: `import { MastheadLogo as ML } from '@patternfly/react-core'; <ML  />`,
+      errors: [
+        {
+          message,
+          type: "JSXOpeningElement",
+        },
+      ],
+    },
+  ],
+});

packages/eslint-plugin-pf-codemods/src/rules/v6/dataCodemodsCleanup/data-codemods-cleanup.ts

@@ -0,0 +1,51 @@
+import { Rule } from "eslint";
+import { ImportSpecifier, JSXOpeningElement } from "estree-jsx";
+import {
+  checkMatchingJSXOpeningElement,
+  getAttribute,
+  getFromPackage,
+} from "../../helpers";
+
+module.exports = {
+  meta: { fixable: "code" },
+  create: function (context: Rule.RuleContext) {
+    const { imports } = getFromPackage(context, "@patternfly/react-core");
+
+    const message =
+      "This rule will remove data-codemods attributes and comments, which were introduced by our codemods in order to work correctly.";
+
+    return {
+      JSXOpeningElement(node: JSXOpeningElement) {
+        if (checkMatchingJSXOpeningElement(node, imports)) {
+          const dataCodemodsAttribute = getAttribute(node, "data-codemods");
+          if (dataCodemodsAttribute) {
+            context.report({
+              node,
+              message,
+              fix(fixer) {
+                return fixer.remove(dataCodemodsAttribute);
+              },
+            });
+          }
+        }
+      },
+      ImportSpecifier(node: ImportSpecifier) {
+        if (imports.some((specifier) => specifier === node)) {
+          const comments = context.getSourceCode().getCommentsAfter(node);
+          const dataCodemodsComment = comments.find((comment) =>
+            comment.value.includes("data-codemods")
+          );
+          if (dataCodemodsComment) {
+            context.report({
+              node,
+              message,
+              fix(fixer) {
+                return fixer.removeRange(dataCodemodsComment.range!);
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};

packages/eslint-plugin-pf-codemods/src/rules/v6/dataCodemodsCleanup/dataCodemodsCleanupInput.tsx

@@ -0,0 +1,13 @@
+import {
+  DualListSelector /* data-codemods */,
+  LoginMainFooterLinksItem,
+  MastheadLogo,
+} from "@patternfly/react-core";
+
+export const DataCodemodsCleanupInput = () => (
+  <>
+    <DualListSelector />
+    <LoginMainFooterLinksItem data-codemods="true" />
+    <MastheadLogo data-codemods />
+  </>
+);

packages/eslint-plugin-pf-codemods/src/rules/v6/dataCodemodsCleanup/dataCodemodsCleanupOutput.tsx

@@ -0,0 +1,13 @@
+import {
+  DualListSelector,
+  LoginMainFooterLinksItem,
+  MastheadLogo,
+} from "@patternfly/react-core";
+
+export const DataCodemodsCleanupInput = () => (
+  <>
+    <DualListSelector />
+    <LoginMainFooterLinksItem />
+    <MastheadLogo />
+  </>
+);