feat(Masthead): Remove backgroundColor prop

patternfly · Feb 15, 2024 · 15df1ac · 15df1ac
1 parent 18edec9
commit 15df1ac
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 80 deletions.
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "test:v6": "yarn build && mocha packages/eslint-plugin-pf-codemods/dist/js/rules/v6/*/*.test.js",
     "test:v4:single": "pf-codemods --v4 --no-cache test/v4test.tsx",
     "test:v5:single": "pf-codemods --no-cache test/test.tsx",
-    "test:v6:single": "yarn build && pf-codemods --v6 --no-cache packages/eslint-plugin-pf-codemods/src/rules/v6/*/*.tsx",
+    "test:v6:single": "yarn build && pf-codemods --v6 --no-cache packages/eslint-plugin-pf-codemods/src/rules/v6/*/*Input.tsx",
     "test:koku": "pf-codemods --no-cache test/koku-ui",
     "test:console": "pf-codemods --no-cache test/console/frontend",
     "test:integreatly": "pf-codemods --no-cache test/tutorial-web-app",

diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.md b/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.md
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.test.ts b/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.test.ts
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.ts b/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/example-rule.ts
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/exampleRuleInput.tsx b/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/exampleRuleInput.tsx
diff --git a/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/exampleRuleOutput.tsx b/packages/eslint-plugin-pf-codemods/src/rules/v6/exampleRule/exampleRuleOutput.tsx
diff --git a/.../src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.md b/.../src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.md
@@ -0,0 +1,18 @@
+### masthead-remove-background-color [(#9744)](https://github.com/patternfly/patternfly-react/pull/9744)
+
+We've removed the `backgroundColor` prop from Masthead as theming is no longer handled React-side.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
+
diff --git a/...emods/src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.test.ts b/...emods/src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.test.ts
@@ -0,0 +1,21 @@
+const ruleTester = require('../../ruletester');
+import * as rule from './masthead-remove-background-color';
+
+ruleTester.run("masthead-remove-background-color", rule, {
+  valid: [
+    {
+      code: `<Masthead backgroundColor />`
+    }
+  ],
+  invalid: [
+    {
+      code:   `import { Masthead } from '@patternfly/react-core'; <Masthead backgroundColor />`,
+      output: `import { Masthead } from '@patternfly/react-core'; <Masthead  />`,
+      errors: [{
+        message: `We've removed the \`backgroundColor\` prop from Masthead as theming is no longer handled React-side.`,
+        type: "JSXOpeningElement",
+      }]
+    },
+  ]
+});
+
diff --git a/...f-codemods/src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.ts b/...f-codemods/src/rules/v6/mastheadRemoveBackgroundColor/masthead-remove-background-color.ts
@@ -0,0 +1,16 @@
+import { renameProps } from '../../helpers';
+
+// https://github.com/patternfly/patternfly-react/pull/9744
+module.exports = {
+  meta: { fixable: 'code' },
+  create: renameProps({
+    Masthead: {
+      "backgroundColor": {
+        newName: "",
+        message: () =>
+          "We've removed the `backgroundColor` prop from Masthead as theming is no longer handled React-side.",
+      },
+    },
+  }),
+};
+
diff --git a/...odemods/src/rules/v6/mastheadRemoveBackgroundColor/mastheadRemoveBackgroundColorInput.tsx b/...odemods/src/rules/v6/mastheadRemoveBackgroundColor/mastheadRemoveBackgroundColorInput.tsx
@@ -0,0 +1,3 @@
+import { Masthead } from "@patternfly/react-core";
+
+export const MastheadRemoveBackgroundColorInput = () => <Masthead backgroundColor />
diff --git a/...demods/src/rules/v6/mastheadRemoveBackgroundColor/mastheadRemoveBackgroundColorOutput.tsx b/...demods/src/rules/v6/mastheadRemoveBackgroundColor/mastheadRemoveBackgroundColorOutput.tsx
@@ -0,0 +1,3 @@
+import { Masthead } from "@patternfly/react-core";
+
+export const MastheadRemoveBackgroundColorInput = () => <Masthead  />
diff --git a/packages/pf-codemods/README.md b/packages/pf-codemods/README.md
@@ -46,25 +46,25 @@ These rules are based off the breaking change notes for React. Each rule links t
 
 Some rules will add either a comment (`/* data-codemods */`) or data attribute (`data-codemods="true"`) in order to prevent certain other rules from applying an unnecessary fix.
 
-### example-rule[(#1234)](https://github.com/patternfly/patternfly-react/pull/1234)
+### masthead-remove-background-color [(#9744)](https://github.com/patternfly/patternfly-react/pull/9744)
 
-We've renamed the `ComponentName` component to `NewComponentName`.
+We've removed the `backgroundColor` prop from Masthead as theming is no longer handled React-side.
 
 #### Examples
 
 In:
 
 ```jsx
-import { ComponentName } from "@patternfly/react-core";
+import { Masthead } from "@patternfly/react-core";
 
-export const ExampleRule = () => <ComponentName propName="foo">Body</ComponentName>;
+export const MastheadRemoveBackgroundColorInput = () => <Masthead backgroundColor />
 ```
 
 Out:
 
 ```jsx
-import { ComponentName } from "@patternfly/react-core";
+import { Masthead } from "@patternfly/react-core";
 
-export const ExampleRule = () => <ComponentName >Body</ComponentName>;
+export const MastheadRemoveBackgroundColorInput = () => <Masthead  />
 ```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { Masthead } from "@patternfly/react-core";

		export const MastheadRemoveBackgroundColorInput = () => <Masthead backgroundColor />