feat(Modal): promoted Next implementation (#660)

* feat(Modal): promoted Next implementation

* Created test helpers file

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

@@ -0,0 +1,25 @@
+import { RuleTester } from "eslint";
+
+export type ValidTests = Array<string | RuleTester.ValidTestCase>;
+export type InvalidTests = RuleTester.InvalidTestCase[];
+type TestErrors = {
+  message: string;
+  type: string;
+}[];
+
+export function createValidTest(code: string) {
+  return {
+    code,
+  };
+}
+export function createInvalidTest(
+  code: string,
+  output: string,
+  errors: TestErrors
+) {
+  return {
+    code,
+    output,
+    errors,
+  };
+}

packages/eslint-plugin-pf-codemods/src/rules/v6/modalDeprecated/modal-deprecated.md

@@ -0,0 +1,17 @@
+### modal-deprecated [(#10358)](https://github.com/patternfly/patternfly-react/pull/10358)
+
+Our previous implementation of Modal has been deprecated. This rule will update import paths to our deprecated directory, but we recommend using our newly promoted implementation.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```

packages/eslint-plugin-pf-codemods/src/rules/v6/modalDeprecated/modal-deprecated.test.ts

@@ -0,0 +1,126 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./modal-deprecated";
+import {
+  ValidTests,
+  InvalidTests,
+  createValidTest,
+  createInvalidTest,
+} from "../../helpers/testHelpers";
+
+const specifiersToMove = [
+  "Modal",
+  "ModalVariant",
+  "ModalBox",
+  "ModalBoxBody",
+  "ModalBoxCloseButton",
+  "ModalBoxHeader",
+  "ModalBoxFooter",
+  "ModalContent",
+];
+
+const validTests: ValidTests = [];
+const invalidTests: InvalidTests = [];
+
+specifiersToMove.forEach((specifier) => {
+  if (!specifier.endsWith("Variant")) {
+    validTests.push(createValidTest(`<${specifier} />`));
+  }
+  validTests.push(
+    createValidTest(
+      `import { ${specifier} /* data-codemods */ } from '@patternfly/react-core';`
+    )
+  );
+  validTests.push(
+    createValidTest(
+      `import { ${specifier} } from '@patternfly/react-core/deprecated';`
+    )
+  );
+  validTests.push(
+    createValidTest(
+      `export { ${specifier} /* data-codemods */ } from '@patternfly/react-core';`
+    )
+  );
+  validTests.push(
+    createValidTest(
+      `export { ${specifier} } from '@patternfly/react-core/deprecated';`
+    )
+  );
+
+  const errorMessage = `${specifier} has been deprecated. This rule will update import paths to our deprecated directory, but we recommend using our newly promoted Modal implementation.`;
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} as CustomSpecifier } from '@patternfly/react-core';`,
+      `import {\n\t${specifier} as CustomSpecifier\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/esm/components/Modal/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-core/dist/esm/deprecated/components/Modal/index.js';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/js/components/Modal/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/dynamic/components/Modal/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core';`,
+      `export {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/esm/components/Modal/index.js';`,
+      `export {\n\t${specifier}\n} from '@patternfly/react-core/dist/esm/deprecated/components/Modal/index.js';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/js/components/Modal/index.js';`,
+      `export {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/dynamic/components/Modal/index.js';`,
+      `export {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier}, Button } from '@patternfly/react-core';`,
+      `import {\n\tButton\n} from '@patternfly/react-core';
+import {\n\t${specifier}\n} from '@patternfly/react-core/deprecated';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+});
+
+ruleTester.run("modal-deprecated", rule, {
+  valid: validTests,
+  invalid: invalidTests,
+});

packages/eslint-plugin-pf-codemods/src/rules/v6/modalDeprecated/modal-deprecated.ts

@@ -0,0 +1,29 @@
+import { moveSpecifiers } from "../../helpers";
+
+// https://github.com/patternfly/patternfly-react/pull/10358
+
+const specifiersToMove = [
+  "Modal",
+  "ModalVariant",
+  "ModalBox",
+  "ModalBoxBody",
+  "ModalBoxCloseButton",
+  "ModalBoxHeader",
+  "ModalBoxFooter",
+  "ModalContent",
+];
+
+const fromPackage = "@patternfly/react-core";
+const toPackage = "@patternfly/react-core/deprecated";
+const messageAfterImportNameChange =
+  "been deprecated. This rule will update import paths to our deprecated directory, but we recommend using our newly promoted Modal implementation.";
+
+module.exports = {
+  meta: { fixable: "code" },
+  create: moveSpecifiers(
+    specifiersToMove,
+    fromPackage,
+    toPackage,
+    messageAfterImportNameChange
+  ),
+};

packages/eslint-plugin-pf-codemods/src/rules/v6/modalDeprecated/modalDeprecatedInput.tsx

@@ -0,0 +1 @@
+import { Modal } from "@patternfly/react-core";

packages/eslint-plugin-pf-codemods/src/rules/v6/modalDeprecated/modalDeprecatedOutput.tsx

@@ -0,0 +1,3 @@
+import {
+	Modal
+} from '@patternfly/react-core/deprecated';

packages/eslint-plugin-pf-codemods/src/rules/v6/modalNextPromoted/modalNext-promoted.md

@@ -0,0 +1,17 @@
+### modalNext-promoted [(#10358)](https://github.com/patternfly/patternfly-react/pull/10358)
+
+Our Next implementation of Modal has been promoted as our recommended implementation. This rule will update import paths.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```

packages/eslint-plugin-pf-codemods/src/rules/v6/modalNextPromoted/modalNext-promoted.test.ts

@@ -0,0 +1,111 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./modalNext-promoted";
+import {
+  ValidTests,
+  InvalidTests,
+  createValidTest,
+  createInvalidTest,
+} from "../../helpers/testHelpers";
+
+const specifiersToMove = ["Modal", "ModalBody", "ModalHeader", "ModalFooter"];
+const validTests: ValidTests = [];
+const invalidTests: InvalidTests = [];
+
+specifiersToMove.forEach((specifier) => {
+  if (!specifier.endsWith("Variant")) {
+    validTests.push(createValidTest(`<${specifier} />`));
+  }
+  validTests.push(
+    createValidTest(
+      `import { ${specifier} /* data-codemods */ } from '@patternfly/react-core';`
+    )
+  );
+  validTests.push(
+    createValidTest(`import { ${specifier} } from '@patternfly/react-core';`)
+  );
+  validTests.push(
+    createValidTest(
+      `export { ${specifier} /* data-codemods */ } from '@patternfly/react-core';`
+    )
+  );
+  validTests.push(
+    createValidTest(`export { ${specifier} } from '@patternfly/react-core';`)
+  );
+
+  const errorMessage = `${specifier} has been promoted. This rule will update import paths.`;
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/next';`,
+      `import {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} as CustomSpecifier } from '@patternfly/react-core/next';`,
+      `import {\n\t${specifier} as CustomSpecifier /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/esm/next/components/Modal/index.js';`,
+      `import {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core/dist/esm/components/Modal/index.js';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/js/next/components/Modal/index.js';`,
+      `import {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/dist/dynamic/next/components/Modal/index.js';`,
+      `import {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/next';`,
+      `export {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/esm/next/components/Modal/index.js';`,
+      `export {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core/dist/esm/components/Modal/index.js';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/js/next/components/Modal/index.js';`,
+      `export {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `export { ${specifier} } from '@patternfly/react-core/dist/dynamic/next/components/Modal/index.js';`,
+      `export {\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ExportNamedDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-core/next';\nimport { Button } from '@patternfly/react-core';`,
+      `\nimport {\n\tButton,\n\t${specifier} /* data-codemods */\n} from '@patternfly/react-core';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+});
+
+ruleTester.run("modalNext-promoted", rule, {
+  valid: validTests,
+  invalid: invalidTests,
+});

packages/eslint-plugin-pf-codemods/src/rules/v6/modalNextPromoted/modalNext-promoted.ts

@@ -0,0 +1,20 @@
+import { moveSpecifiers } from "../../helpers";
+
+// https://github.com/patternfly/patternfly-react/pull/10358
+
+const specifiersToMove = ["Modal", "ModalBody", "ModalHeader", "ModalFooter"];
+
+const fromPackage = "@patternfly/react-core/next";
+const toPackage = "@patternfly/react-core";
+const messageAfterImportNameChange =
+  "been promoted. This rule will update import paths.";
+
+module.exports = {
+  meta: { fixable: "code" },
+  create: moveSpecifiers(
+    specifiersToMove,
+    fromPackage,
+    toPackage,
+    messageAfterImportNameChange
+  ),
+};

packages/eslint-plugin-pf-codemods/src/rules/v6/modalNextPromoted/modalNextPromotedInput.tsx

@@ -0,0 +1 @@
+import { Modal } from "@patternfly/react-core/next";

packages/eslint-plugin-pf-codemods/src/rules/v6/modalNextPromoted/modalNextPromotedOutput.tsx

@@ -0,0 +1,3 @@
+import {
+	Modal /* data-codemods */
+} from '@patternfly/react-core';