AG-16020 (#118)

eliasmalik · web-flow · commit 0e4668bbe346 · 2025-09-30T17:02:46.000+01:00
* add v34.3 transform boilerplate

* add codemod and simple test
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/README.md b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/README.md
@@ -0,0 +1,27 @@
+# `transform-grid-options-v34-3`
+
+> _Transform deprecated Grid options_
+
+See the [`transform-grid-options`](../../plugins/transform-grid-options/) plugin for usage instructions.
+
+## Common tasks
+
+### Add a test case
+
+Create a new unit test scenario for this transform:
+
+```
+pnpm run task:create-test --type transform --target transform-grid-options-v34-3
+```
+
+### Add a new rule
+
+Replacement rules are specified in [`replacements.ts`](./replacements.ts)
+
+### Add to a codemod release
+
+Add this source code transformation to a codemod release:
+
+```
+pnpm run task:include-transform --transform transform-grid-options-v34-3
+```
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/input.js b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/input.js
@@ -0,0 +1,12 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [
+    { field: 'date' },
+    { field: 'country' },
+  ],
+  rowData: [],
+  hello: 'world',
+  goodbye: 'world',
+  friendly: true,
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.errors.cjs b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.errors.cjs
@@ -0,0 +1 @@
+module.exports = [];
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.js b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.js
@@ -0,0 +1,12 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [
+    { field: 'date' },
+    { field: 'country' },
+  ],
+  rowData: [],
+  hello: 'world',
+  goodbye: 'world',
+  friendly: true,
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.warnings.cjs b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/output.warnings.cjs
@@ -0,0 +1 @@
+module.exports = [];
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/scenario.json b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/no-op/scenario.json
@@ -0,0 +1,8 @@
+{
+  "scenario": {
+    "input": "input.js",
+    "output": "output.js",
+    "errors": "output.errors.cjs",
+    "warnings": "output.warnings.cjs"
+  }
+}
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/input.js b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/input.js
@@ -0,0 +1,15 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [
+    { 
+      field: 'date',
+      rowGroupingHierarchy: ['foo', 'bar'],
+    },
+    { field: 'country' },
+  ],
+  rowData: [],
+  hello: 'world',
+  goodbye: 'world',
+  friendly: true,
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.errors.cjs b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.errors.cjs
@@ -0,0 +1 @@
+module.exports = [];
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.js b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.js
@@ -0,0 +1,15 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [
+    { 
+      field: 'date',
+      groupHierarchy: ['foo', 'bar'],
+    },
+    { field: 'country' },
+  ],
+  rowData: [],
+  hello: 'world',
+  goodbye: 'world',
+  friendly: true,
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.warnings.cjs b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/output.warnings.cjs
@@ -0,0 +1 @@
+module.exports = [];
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/scenario.json b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/__fixtures__/scenarios/js/rename-field/scenario.json
@@ -0,0 +1,8 @@
+{
+  "scenario": {
+    "input": "input.js",
+    "output": "output.js",
+    "errors": "output.errors.cjs",
+    "warnings": "output.warnings.cjs"
+  }
+}
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/index.ts b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/index.ts
@@ -0,0 +1 @@
+export { default } from './transform-grid-options-v34-3';
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/manifest.ts b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/manifest.ts
@@ -0,0 +1,8 @@
+import { type TransformManifest } from '@ag-grid-devtools/types';
+
+const manifest: TransformManifest = {
+  name: 'Transform Grid options v34.3',
+  description: 'Transform deprecated Grid options',
+};
+
+export default manifest;
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/replacements.ts b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/replacements.ts
@@ -0,0 +1,23 @@
+import {
+  migrateOptionalValue,
+  migrateProperty,
+  transformObjectListValue,
+  transformObjectProperties,
+  transformOptionalValue,
+  transformPropertyValue,
+  type CodemodObjectPropertyReplacement,
+} from '../../plugins/transform-grid-options/transform-grid-options';
+
+const MIGRATION_URL = 'https://ag-grid.com/javascript-data-grid/upgrading-to-ag-grid-34-3/';
+
+export const replacements: Array<CodemodObjectPropertyReplacement> = transformObjectProperties({
+  columnDefs: transformPropertyValue(
+    transformOptionalValue(
+      transformObjectListValue(
+        transformObjectProperties({
+          rowGroupingHierarchy: migrateProperty('groupHierarchy', migrateOptionalValue()),
+        }),
+      ),
+    ),
+  ),
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/transform-grid-options-v34-3.test.ts b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/transform-grid-options-v34-3.test.ts
@@ -0,0 +1,16 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, onTestFinished, test } from 'vitest';
+import { loadTransformScenarios } from '../../test/runners/transform';
+
+import transformGridOptionsV34_3 from './transform-grid-options-v34-3';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+describe(transformGridOptionsV34_3, () => {
+  const scenariosPath = join(__dirname, './__fixtures__/scenarios');
+  loadTransformScenarios(scenariosPath, {
+    transforms: [transformGridOptionsV34_3],
+    vitest: { describe, expect, test, onTestFinished },
+  });
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/transform-grid-options-v34-3.ts b/packages/cli/src/codemods/transforms/transform-grid-options-v34-3/transform-grid-options-v34-3.ts
@@ -0,0 +1,11 @@
+import { type AstCliContext, type AstTransform } from '@ag-grid-devtools/ast';
+import { transformGridOptions } from '../../plugins/transform-grid-options';
+import { replacements } from './replacements';
+
+const plugin: AstTransform<AstCliContext> = transformGridOptions(replacements);
+
+const transform: AstTransform<AstCliContext> = function transformGridOptionsV34_3(babel) {
+  return plugin(babel);
+};
+
+export default transform;
diff --git a/packages/cli/src/codemods/versions/34.3.0/README.md b/packages/cli/src/codemods/versions/34.3.0/README.md
@@ -0,0 +1,35 @@
+# 34.3.0
+
+Codemod for upgrading to [AG Grid v34.3.0](https://github.com/ag-grid/ag-grid/releases/tag/v34.3.0)
+
+## Usage
+
+```
+npx @ag-grid-devtools/cli migrate --to 34.3.0
+```
+
+Source code transformations applied by this codemod are specified in [`transforms.ts`](./transforms.ts).
+
+## Common tasks
+
+### Add a transform
+
+Option 1: Create a new source code transformation to add to this codemod release version:
+
+```
+pnpm run task:create-transform --release 34.3.0
+```
+
+Option 2: Add an existing source code transformation to this codemod release version:
+
+```
+pnpm run task:include-transform --version 34.3.0
+```
+
+### Add a test case
+
+Create a new unit test scenario for this version:
+
+```
+pnpm run task:create-test --type version --target 34.3.0
+```
diff --git a/packages/cli/src/codemods/versions/34.3.0/__fixtures__/scenarios/.gitignore b/packages/cli/src/codemods/versions/34.3.0/__fixtures__/scenarios/.gitignore
diff --git a/packages/cli/src/codemods/versions/34.3.0/codemod.test.ts b/packages/cli/src/codemods/versions/34.3.0/codemod.test.ts
@@ -0,0 +1,16 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, onTestFinished, test } from 'vitest';
+import { loadCodemodExampleScenarios } from '../../test/runners/codemod';
+
+import codemod from './codemod';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+describe(codemod, () => {
+  const scenariosPath = join(__dirname, './__fixtures__/scenarios');
+  loadCodemodExampleScenarios(scenariosPath, {
+    codemod,
+    vitest: { describe, expect, test, onTestFinished },
+  });
+});
diff --git a/packages/cli/src/codemods/versions/34.3.0/codemod.ts b/packages/cli/src/codemods/versions/34.3.0/codemod.ts
@@ -0,0 +1,24 @@
+import { transformFileAst } from '@ag-grid-devtools/codemod-utils';
+import {
+  type Codemod,
+  type CodemodInput,
+  type CodemodOptions,
+  type CodemodResult,
+} from '@ag-grid-devtools/types';
+
+import transforms from './transforms';
+
+const codemod: Codemod = function codemodV34_3_0(
+  file: CodemodInput,
+  options: CodemodOptions,
+): CodemodResult {
+  const { path, source } = file;
+  const { fs, userConfig } = options;
+  return transformFileAst(source, transforms, {
+    filename: path,
+    fs,
+    userConfig,
+  });
+};
+
+export default codemod;
diff --git a/packages/cli/src/codemods/versions/34.3.0/manifest.ts b/packages/cli/src/codemods/versions/34.3.0/manifest.ts
@@ -0,0 +1,13 @@
+import { type TransformManifest, type VersionManifest } from '@ag-grid-devtools/types';
+
+import transformGridOptionsV34_3 from '../../transforms/transform-grid-options-v34-3/manifest.ts';
+
+const transforms: Array<TransformManifest> = [transformGridOptionsV34_3];
+
+const manifest: VersionManifest = {
+  version: '34.3.0',
+  codemodPath: 'versions/34.3.0',
+  transforms,
+};
+
+export default manifest;
diff --git a/packages/cli/src/codemods/versions/34.3.0/transforms.ts b/packages/cli/src/codemods/versions/34.3.0/transforms.ts
@@ -0,0 +1,7 @@
+import { type AstCliContext, type AstTransform } from '@ag-grid-devtools/ast';
+
+import transformGridOptionsV34_3 from '../../transforms/transform-grid-options-v34-3';
+
+const transforms: Array<AstTransform<AstCliContext>> = [transformGridOptionsV34_3];
+
+export default transforms;
diff --git a/packages/cli/src/codemods/versions/manifest.ts b/packages/cli/src/codemods/versions/manifest.ts
@@ -22,6 +22,8 @@ import v33_3_0 from './33.3.0/manifest';
 
 import v34_0_0 from './34.0.0/manifest';
 
+import v34_3_0 from './34.3.0/manifest';
+
 const versions: Array<VersionManifest> = [
   v31_0_0,
   v31_1_0,
@@ -34,6 +36,7 @@ const versions: Array<VersionManifest> = [
   v33_2_0,
   v33_3_0,
   v34_0_0,
+  v34_3_0,
 ];
 
 export default versions;
