feat(Page): rename header to masthead (#652)

* feat(Page): rename header to masthead * test(Page): add test for aliased import * chore(Page): better error message
patternfly · Jun 6, 2024 · b3e8f40 · b3e8f40
1 parent 46b9ff7
commit b3e8f40
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 0 deletions.
diff --git a/...s/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.md b/...s/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.md
@@ -0,0 +1,17 @@
+### page-rename-header [(#10454)](https://github.com/patternfly/patternfly-react/pull/10454)
+
+We've renamed the `header` prop for Page to `masthead`.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.test.ts b/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.test.ts
@@ -0,0 +1,45 @@
+const ruleTester = require('../../ruletester');
+import * as rule from './page-rename-header';
+
+const error = {
+  message: `We've renamed the \`header\` prop for Page to \`masthead\`.`,
+  type: 'JSXOpeningElement',
+};
+
+ruleTester.run('page-rename-header', rule, {
+  valid: [
+    {
+      code: `<Page header />`,
+    },
+    {
+      code: `import { Page } from '@patternfly/react-core'; <Page someOtherProp />`,
+    },
+  ],
+  invalid: [
+    {
+      code: `import { Page } from '@patternfly/react-core'; <Page header={<Masthead />} />`,
+      output: `import { Page } from '@patternfly/react-core'; <Page masthead={<Masthead />} />`,
+      errors: [error],
+    },
+    {
+      code: `import { Page as CustomPage } from '@patternfly/react-core'; <CustomPage header={<Masthead />} />`,
+      output: `import { Page as CustomPage } from '@patternfly/react-core'; <CustomPage masthead={<Masthead />} />`,
+      errors: [error],
+    },
+    {
+      code: `import { Page } from '@patternfly/react-core/dist/esm/components/Page/index.js'; <Page header={<Masthead />} />`,
+      output: `import { Page } from '@patternfly/react-core/dist/esm/components/Page/index.js'; <Page masthead={<Masthead />} />`,
+      errors: [error],
+    },
+    {
+      code: `import { Page } from '@patternfly/react-core/dist/js/components/Page/index.js'; <Page header={<Masthead />} />`,
+      output: `import { Page } from '@patternfly/react-core/dist/js/components/Page/index.js'; <Page masthead={<Masthead />} />`,
+      errors: [error],
+    },
+    {
+      code: `import { Page } from '@patternfly/react-core/dist/dynamic/components/Page/index.js'; <Page header={<Masthead />} />`,
+      output: `import { Page } from '@patternfly/react-core/dist/dynamic/components/Page/index.js'; <Page masthead={<Masthead />} />`,
+      errors: [error],
+    },
+  ],
+});
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.ts b/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/page-rename-header.ts
@@ -0,0 +1,14 @@
+import { renameProps } from '../../helpers';
+
+// https://github.com/patternfly/patternfly-react/pull/10454
+module.exports = {
+  meta: { fixable: 'code' },
+  create: renameProps({
+    Page: {
+      header: {
+        newName: 'masthead',
+        message: `We've renamed the \`header\` prop for Page to \`masthead\`.`,
+      },
+    },
+  }),
+};
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/pageRenameHeaderInput.tsx b/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/pageRenameHeaderInput.tsx
@@ -0,0 +1,3 @@
+import { Page } from '@patternfly/react-core';
+
+export const PageRenameHeaderInput = () => <Page header={<Masthead />} />;
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/pageRenameHeaderOutput.tsx b/packages/eslint-plugin-pf-codemods/src/rules/v6/pageRenameHeader/pageRenameHeaderOutput.tsx
@@ -0,0 +1,3 @@
+import { Page } from '@patternfly/react-core';
+
+export const PageRenameHeaderInput = () => <Page masthead={<Masthead />} />;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { Page } from '@patternfly/react-core';

		export const PageRenameHeaderInput = () => <Page header={<Masthead />} />;