feat(componentGroups): rename InvalidObjectProps to MissingPageProps

packages/eslint-plugin-pf-codemods/package.json

@@ -24,6 +24,7 @@
   },
   "devDependencies": {
     "@types/eslint": "^8.56.0",
-    "@types/estree-jsx": "^1.0.4"
+    "@types/estree-jsx": "^1.0.4",
+    "@typescript-eslint/utils": "^8.12.2"
   }
 }

packages/eslint-plugin-pf-codemods/src/rules/helpers/index.ts

@@ -26,9 +26,12 @@ export * from "./isReactIcon";
 export * from "./JSXAttributes";
 export * from "./makeJSXElementSelfClosing";
 export * from "./nodeMatches/checkMatchingImportDeclaration";
+export * from "./nodeMatches/checkMatchingImportSpecifier";
 export * from "./nodeMatches/checkMatchingJSXOpeningElement";
 export * from "./pfPackageMatches";
 export * from "./removeElement";
 export * from "./removeEmptyLineAfter";
 export * from "./removePropertiesFromObjectExpression";
+export * from "./renameComponent";
+export * from "./renameInterface";
 export * from "./renameProps";

packages/eslint-plugin-pf-codemods/src/rules/helpers/nodeMatches/checkMatchingImportSpecifier.ts

@@ -0,0 +1,15 @@
+import { ImportSpecifier } from "estree-jsx";
+
+/** Used to check whether the current ImportSpecifier node matches at least 1 of the import specifiers. */
+export function checkMatchingImportSpecifier(
+  node: ImportSpecifier,
+  imports: ImportSpecifier | ImportSpecifier[]
+) {
+  if (Array.isArray(imports)) {
+    return imports.some(
+      (specifier) => specifier.imported.name === node.imported.name
+    );
+  }
+
+  return imports.imported.name === node.imported.name;
+}

packages/eslint-plugin-pf-codemods/src/rules/helpers/renameInterface.ts

@@ -0,0 +1,83 @@
+import { Rule } from "eslint";
+import { TSESTree } from "@typescript-eslint/utils";
+import { Identifier, ImportSpecifier } from "estree-jsx";
+import { getFromPackage } from "./getFromPackage";
+import { checkMatchingImportSpecifier } from "./nodeMatches/checkMatchingImportSpecifier";
+
+interface InterfaceRenames {
+  [currentName: string]: string;
+}
+
+function formatDefaultMessage(oldName: string, newName: string) {
+  return `${oldName} has been renamed to ${newName}.`;
+}
+
+export function renameInterface(
+  renames: InterfaceRenames,
+  packageName = "@patternfly/react-core"
+) {
+  return function (context: Rule.RuleContext) {
+    const oldNames = Object.keys(renames);
+    const { imports } = getFromPackage(context, packageName, oldNames);
+
+    if (imports.length === 0) {
+      return {};
+    }
+
+    const shouldRenameIdentifier = (identifier: Identifier) => {
+      const matchingImport = imports.find(
+        (specifier) => specifier.local.name === identifier.name
+      );
+
+      if (!matchingImport) {
+        return false;
+      }
+
+      return matchingImport.local.name === matchingImport.imported.name;
+    };
+
+    const replaceIdentifier = (identifier: Identifier) => {
+      const oldName = identifier.name;
+      const newName = renames[oldName];
+
+      context.report({
+        node: identifier,
+        message: formatDefaultMessage(oldName, newName),
+        fix(fixer) {
+          return fixer.replaceText(identifier, newName);
+        },
+      });
+    };
+
+    return {
+      ImportSpecifier(node: ImportSpecifier) {
+        if (!checkMatchingImportSpecifier(node, imports)) {
+          return;
+        }
+
+        const oldName = node.imported.name;
+        const newName = renames[oldName];
+
+        context.report({
+          node,
+          message: formatDefaultMessage(oldName, newName),
+          fix(fixer) {
+            return fixer.replaceText(node.imported, newName);
+          },
+        });
+      },
+      TSTypeReference(node: TSESTree.TSTypeReference) {
+        if (node.typeName.type === "Identifier") {
+          shouldRenameIdentifier(node.typeName) &&
+            replaceIdentifier(node.typeName);
+        }
+      },
+      TSInterfaceHeritage(node: TSESTree.TSInterfaceHeritage) {
+        if (node.expression.type === "Identifier") {
+          shouldRenameIdentifier(node.expression) &&
+            replaceIdentifier(node.expression);
+        }
+      },
+    };
+  };
+}

packages/eslint-plugin-pf-codemods/src/rules/v6/componentGroupsInvalidObjectPropsRenameToMissingPageProps/component-groups-invalidObjectProps-rename-to-missingPageProps.md

@@ -0,0 +1,18 @@
+### component-groups-invalidObjectProps-rename-to-missingPageProps [(react-component-groups/#313)](https://github.com/patternfly/react-component-groups/pull/313)
+
+In react-component-groups, we've renamed InvalidObjectProps interface to MissingPageProps
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
+

packages/eslint-plugin-pf-codemods/src/rules/v6/componentGroupsInvalidObjectPropsRenameToMissingPageProps/component-groups-invalidObjectProps-rename-to-missingPageProps.test.ts

@@ -0,0 +1,99 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./component-groups-invalidObjectProps-rename-to-missingPageProps";
+
+const message = `InvalidObjectProps has been renamed to MissingPageProps.`;
+
+ruleTester.run(
+  "component-groups-invalidObjectProps-rename-to-missingPageProps",
+  rule,
+  {
+    valid: [
+      // missing import
+      {
+        code: `const props: InvalidObjectProps;`,
+      },
+      // import from wrong package
+      {
+        code: `import { InvalidObjectProps } from '@patternfly/react-core';`,
+      },
+      // import of other props
+      {
+        code: `import { SomeOtherProps } from '@patternfly/react-component-groups';`,
+      },
+    ],
+    invalid: [
+      {
+        code: `import { InvalidObjectProps, SomethingElse } from '@patternfly/react-component-groups';
+      const props: InvalidObjectProps;
+      const otherProps = props as InvalidObjectProps;
+      interface CustomProps extends InvalidObjectProps {};`,
+        output: `import { MissingPageProps, SomethingElse } from '@patternfly/react-component-groups';
+      const props: MissingPageProps;
+      const otherProps = props as MissingPageProps;
+      interface CustomProps extends MissingPageProps {};`,
+        errors: [
+          {
+            message,
+            type: "ImportSpecifier",
+          },
+          {
+            message,
+            type: "Identifier",
+          },
+          {
+            message,
+            type: "Identifier",
+          },
+          {
+            message,
+            type: "Identifier",
+          },
+        ],
+      },
+      // named import with alias
+      {
+        code: `import { InvalidObjectProps as InvObjProps } from '@patternfly/react-component-groups';
+        const props: InvObjProps;`,
+        output: `import { MissingPageProps as InvObjProps } from '@patternfly/react-component-groups';
+        const props: InvObjProps;`,
+        errors: [
+          {
+            message,
+            type: "ImportSpecifier",
+          },
+        ],
+      },
+      // imports from dist
+      {
+        code: `import { InvalidObjectProps } from '@patternfly/react-component-groups/dist/cjs/InvalidObject';`,
+        output: `import { MissingPageProps } from '@patternfly/react-component-groups/dist/cjs/InvalidObject';`,
+        errors: [
+          {
+            message,
+            type: "ImportSpecifier",
+          },
+        ],
+      },
+      {
+        code: `import { InvalidObjectProps } from '@patternfly/react-component-groups/dist/esm/InvalidObject';`,
+        output: `import { MissingPageProps } from '@patternfly/react-component-groups/dist/esm/InvalidObject';`,
+        errors: [
+          {
+            message,
+            type: "ImportSpecifier",
+          },
+        ],
+      },
+      {
+        code: `import { InvalidObjectProps } from '@patternfly/react-component-groups/dist/dynamic/InvalidObject';`,
+        output: `import { MissingPageProps } from '@patternfly/react-component-groups/dist/dynamic/InvalidObject';`,
+        errors: [
+          {
+            message,
+            type: "ImportSpecifier",
+          },
+        ],
+      },
+    ],
+  }
+);

packages/eslint-plugin-pf-codemods/src/rules/v6/componentGroupsInvalidObjectPropsRenameToMissingPageProps/component-groups-invalidObjectProps-rename-to-missingPageProps.ts

@@ -0,0 +1,12 @@
+import { renameInterface } from "../../helpers";
+
+// https://github.com/patternfly/react-component-groups/pull/313
+module.exports = {
+  meta: { fixable: "code" },
+  create: renameInterface(
+    {
+      InvalidObjectProps: "MissingPageProps",
+    },
+    "@patternfly/react-component-groups"
+  ),
+};

packages/eslint-plugin-pf-codemods/src/rules/v6/componentGroupsInvalidObjectPropsRenameToMissingPageProps/componentGroupsInvalidObjectPropsRenameToMissingPagePropsInput.tsx

@@ -0,0 +1,4 @@
+import { InvalidObjectProps } from "@patternfly/react-component-groups";
+
+const props: InvalidObjectProps;
+interface CustomProps extends InvalidObjectProps {}

packages/eslint-plugin-pf-codemods/src/rules/v6/componentGroupsInvalidObjectPropsRenameToMissingPageProps/componentGroupsInvalidObjectPropsRenameToMissingPagePropsOutput.tsx

@@ -0,0 +1,4 @@
+import { MissingPageProps } from "@patternfly/react-component-groups";
+
+const props: MissingPageProps;
+interface CustomProps extends MissingPageProps {}