feat(charts): import charts from @patternfly/react-charts/victory

patternfly · Sep 30, 2024 · d7e0d27 · d7e0d27
1 parent 3d91910
commit d7e0d27
Show file tree

Hide file tree

Showing 6 changed files with 205 additions and 0 deletions.
diff --git a/...plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.md b/...plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.md
@@ -0,0 +1,17 @@
+### chartsVictory-promoted [(#11091)](https://github.com/patternfly/patternfly-react/pull/11091)
+
+In order to support multiple chart libraries, Victory has become a peer dependency. This rule will update existing import paths to our victory directory.
+
+#### Examples
+
+In:
+
+```jsx
+%inputExample%
+```
+
+Out:
+
+```jsx
+%outputExample%
+```
diff --git a/...lint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.test.ts b/...lint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.test.ts
@@ -0,0 +1,106 @@
+const ruleTester = require("../../ruletester");
+import * as rule from "./chartsVictory-promoted";
+import {
+  ValidTests,
+  InvalidTests,
+  createValidTest,
+  createInvalidTest,
+} from "../../helpers/testHelpers";
+
+const specifiersToMove = [
+  'Chart',
+  'ChartArea',
+  'ChartAxis',
+  'ChartBar',
+  'ChartBoxPlot',
+  'ChartBullet',
+  'ChartBulletComparativeErrorMeasure',
+  'ChartBulletComparativeMeasure',
+  'ChartBulletComparativeWarningMeasure',
+  'ChartBulletPrimaryDotMeasure',
+  'ChartBulletPrimarySegmentedMeasure',
+  'ChartBulletQualitativeRange',
+  'ChartContainer',
+  'ChartCursorContainer',
+  'ChartCursorTooltip',
+  'ChartCursorFlyout',
+  'ChartDonut',
+  'ChartDonutThreshold',
+  'ChartDonutUtilization',
+  'ChartGroup',
+  'ChartLabel',
+  'ChartLegend',
+  'ChartLegendTooltip',
+  'ChartLegendTooltipContent',
+  'ChartLegendTooltipLabel',
+  'ChartLine',
+  'ChartPie',
+  'ChartPoint',
+  'ChartScatter',
+  'ChartStack',
+  'ChartTheme',
+  'ChartThemeColor',
+  'ChartThreshold',
+  'ChartTooltip',
+  'ChartVoronoiContainer',
+  'createContainer',
+  'getInteractiveLegendEvents',
+  'getInteractiveLegendItemStyles',
+  'getCustomTheme',
+  'getTheme',
+  'getThemeColors'
+];
+
+const validTests: ValidTests = [];
+const invalidTests: InvalidTests = [];
+
+specifiersToMove.forEach((specifier) => {
+  validTests.push(createValidTest(`<${specifier} />`));
+  validTests.push(
+    createValidTest(
+      `import { ${specifier} } from '@patternfly/react-charts/victory';`
+    )
+  );
+
+  const errorMessage = `${specifier} has been promoted. This rule will update existing import paths to our victory directory.`;
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-charts';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-charts/victory';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} as CustomSpecifier } from '@patternfly/react-charts';`,
+      `import {\n\t${specifier} as CustomSpecifier\n} from '@patternfly/react-charts/victory';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-charts/dist/esm/components/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-charts/dist/esm/victory/components/Chart/index.js';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-charts/dist/js/components/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-charts/victory';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+  invalidTests.push(
+    createInvalidTest(
+      `import { ${specifier} } from '@patternfly/react-charts/dist/dynamic/components/index.js';`,
+      `import {\n\t${specifier}\n} from '@patternfly/react-charts/victory';`,
+      [{ message: errorMessage, type: "ImportDeclaration" }]
+    )
+  );
+});
+
+ruleTester.run("chartVictory-promoted", rule, {
+  valid: validTests,
+  invalid: invalidTests,
+});
diff --git a/...es/eslint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.ts b/...es/eslint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictory-promoted.ts
@@ -0,0 +1,62 @@
+import { moveSpecifiers } from "../../helpers";
+
+// https://github.com/patternfly/patternfly-react/pull/11091
+
+const specifiersToMove = [
+'Chart',
+'ChartArea',
+'ChartAxis',
+'ChartBar',
+'ChartBoxPlot',
+'ChartBullet',
+'ChartBulletComparativeErrorMeasure',
+'ChartBulletComparativeMeasure',
+'ChartBulletComparativeWarningMeasure',
+'ChartBulletPrimaryDotMeasure',
+'ChartBulletPrimarySegmentedMeasure',
+'ChartBulletQualitativeRange',
+'ChartContainer',
+'ChartCursorContainer',
+'ChartCursorTooltip',
+'ChartCursorFlyout',
+'ChartDonut',
+'ChartDonutThreshold',
+'ChartDonutUtilization',
+'ChartGroup',
+'ChartLabel',
+'ChartLegend',
+'ChartLegendTooltip',
+'ChartLegendTooltipContent',
+'ChartLegendTooltipLabel',
+'ChartLine',
+'ChartPie',
+'ChartPoint',
+'ChartScatter',
+'ChartStack',
+'ChartTheme',
+'ChartThemeColor',
+'ChartThreshold',
+'ChartTooltip',
+'ChartVoronoiContainer',
+'createContainer',
+'getInteractiveLegendEvents',
+'getInteractiveLegendItemStyles',
+'getCustomTheme',
+'getTheme',
+'getThemeColors'
+];
+
+const fromPackage = "@patternfly/react-chart";
+const toPackage = "@patternfly/react-chart/victory";
+const messageAfterImportNameChange =
+  "been promoted. This rule will update import paths.";
+
+module.exports = {
+  meta: { fixable: "code" },
+  create: moveSpecifiers(
+    specifiersToMove,
+    fromPackage,
+    toPackage,
+    messageAfterImportNameChange
+  ),
+};
diff --git a/...lint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictoryPromotedInput.tsx b/...lint-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictoryPromotedInput.tsx
@@ -0,0 +1 @@
+import { Chart } from "@patternfly/react-charts";
diff --git a/...int-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictoryPromotedOutput.tsx b/...int-plugin-pf-codemods/src/rules/v6/chartsVictoryPromoted/chartsVictoryPromotedOutput.tsx
@@ -0,0 +1 @@
+import { Chart } from '@patternfly/react-charts/victory';
diff --git a/packages/pf-codemods/README.md b/packages/pf-codemods/README.md
@@ -368,6 +368,24 @@ export const CardUpdatedClickableMarkupInput = () => {
 };
 ```
 
+### chartsVictory-promoted [(#11091)](https://github.com/patternfly/patternfly-react/pull/11091)
+
+In order to support multiple chart libraries, Victory has become a peer dependency. This rule will update existing import paths to our victory directory.
+
+#### Examples
+
+In:
+
+```jsx
+import { Chart } from "@patternfly/react-charts";
+```
+
+Out:
+
+```jsx
+import { Chart } from '@patternfly/react-charts/victory';
+```
+
 ### checkbox-radio-replace-isLabelBeforeButton [(#10016)](https://github.com/patternfly/patternfly-react/pull/10016)
 
 The `isLabelBeforeButton` prop in Checkbox and Radio has been replaced with `labelPosition="start"`