Release v34 (#116)

StephenCooper · web-flow · commit e06394ab3e85 · 2025-07-03T12:17:22.000+01:00
Maintain version compatibility with AG Grid.
diff --git a/packages/ast/src/types/transform.ts b/packages/ast/src/types/transform.ts
@@ -47,8 +47,8 @@ export interface FsContext extends TransformContext {
 }
 
 export interface AstCliContext extends FsContext {
-  warn(node: NodePath<AstNode> | null, message: string): void;
-  fail(node: NodePath<AstNode> | null, message: string): void;
+  warn(node: NodePath<AstNode> | Error | null, message: string): void;
+  fail(node: NodePath<AstNode> | Error | null, message: string): void;
 }
 
 export type AstTransformResult = {
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -9,15 +9,15 @@ The AG Grid developer toolkit is distributed as a command-line tool that assists
 Run the following command to list available commands:
 
 ```
-npx @ag-grid-devtools/cli --help
+npx @ag-grid-devtools/cli@latest --help
 ```
 
-> _Note that it is recommended to run a specific version of the developer toolkit, e.g._ `@ag-grid-devtools/cli@31.0`
+> _Note that it is recommended to run the latest version of the developer toolkit, e.g._ `@ag-grid-devtools/cli@latest` as this will contain all previous migrations as well as the latest bug fixes.
 
 ### Available commands
 
 The CLI tool contains the following commands:
 
 - `migrate`: Migrate an existing codebase to use a newer version of AG grid
 
-See the command-line help for more details.
+See the command-line help for more details or the [AG Grid Docs](https://ag-grid.com/javascript-data-grid/codemods/).
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@ag-grid-devtools/cli",
-  "version": "33.3.0",
+  "version": "34.0.0",
   "license": "MIT",
   "description": "AG Grid developer toolkit",
   "author": "AG Grid <info@ag-grid.com>",
diff --git a/packages/cli/src/codemods/plugins/jscodeshift/jscodeshift.adapter.ts b/packages/cli/src/codemods/plugins/jscodeshift/jscodeshift.adapter.ts
@@ -1,7 +1,12 @@
 import j, { Collection } from 'jscodeshift';
-import { AstCliContext, AstTransform, NodePath } from '@ag-grid-devtools/ast';
+import { AstCliContext, AstTransform, NodePath, Node } from '@ag-grid-devtools/ast';
 
-export type JSCodeShiftTransformer = (root: Collection) => void | any;
+export type ErrorSpec = { path: j.ASTPath<j.Node>; message: string };
+
+export type JSCodeShiftTransformer = (root: Collection) => void | {
+  errors: ErrorSpec[];
+  warnings: ErrorSpec[];
+};
 
 // Use https://astexplorer.net/ to iterate on your transformer
 // Parser: Typescript
@@ -15,11 +20,16 @@ export type JSCodeShiftTransformer = (root: Collection) => void | any;
 export const jsCodeShiftTransform = (
   ...transforms: JSCodeShiftTransformer[]
 ): AstTransform<AstCliContext> => {
+  const errors: Error[] = [];
+  const warnings: Error[] = [];
+  let source: any;
+
   return (_babel) => ({
     visitor: {
       Program: {
         exit(path: NodePath) {
-          const root: Collection<any> = j((path.hub as any).file.ast);
+          source = (path.hub as any).file.ast;
+          const root: Collection<any> = j(source);
           const getFirstNode = () => root.find(j.Program).get('body', 0).node;
 
           // save initial comment if any
@@ -28,7 +38,21 @@ export const jsCodeShiftTransform = (
 
           // transform
           for (const transform of transforms) {
-            transform(root);
+            const result = transform(root);
+            if (result?.errors) {
+              errors.push(
+                ...result.errors.map((error) =>
+                  path.hub.buildError(error.path.node as Node, error.message),
+                ),
+              );
+            }
+            if (result?.warnings) {
+              warnings.push(
+                ...result.warnings.map((warning) =>
+                  path.hub.buildError(warning.path.node as Node, warning.message),
+                ),
+              );
+            }
           }
 
           // restore initial comment if any
@@ -43,5 +67,14 @@ export const jsCodeShiftTransform = (
         },
       },
     },
+    post(_file) {
+      for (const warning of warnings) {
+        this.opts.warn(warning, warning.message);
+      }
+
+      for (const error of errors) {
+        this.opts.fail(error, error.message);
+      }
+    },
   });
 };
diff --git a/packages/cli/src/codemods/transforms/transform-modules-to-packages-v33/transformers/package-transforms.ts b/packages/cli/src/codemods/transforms/transform-modules-to-packages-v33/transformers/package-transforms.ts
@@ -47,7 +47,7 @@ export const packageLicenseManager: JSCodeShiftTransformer = (root) => {
 
   if (alreadyExists) {
     // This package file already has a ModuleRegistry import so looks like it has already been transformed
-    return root.toSource();
+    return;
   }
 
   const usingCharts: UsingCharts = process.env.AG_USING_CHARTS as any;
diff --git a/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-chart-type-subobject.ts b/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-chart-type-subobject.ts
@@ -4,7 +4,7 @@ import { JSCodeShiftTransformer } from '../../../plugins/jscodeshift';
 const chartTypeKeys = ['area', 'bar', 'column', 'line'];
 
 // find [chart-type] keys, and merge their contents into the parent object
-export const chartTypeSubobject: JSCodeShiftTransformer = (root) =>
+export const chartTypeSubobject: JSCodeShiftTransformer = (root) => {
   root
     .find(j.ObjectProperty, { key: { name: 'cellRendererParams' } })
     .find(j.ObjectProperty, { key: { name: 'sparklineOptions' } })
@@ -17,3 +17,4 @@ export const chartTypeSubobject: JSCodeShiftTransformer = (root) =>
       });
       path.replace();
     });
+};
diff --git a/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-column.ts b/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-column.ts
@@ -2,7 +2,7 @@ import j from 'jscodeshift';
 import { JSCodeShiftTransformer } from '../../../plugins/jscodeshift';
 
 // update bar/column types to bar with matching direction
-export const columnToVerticalBarTransform: JSCodeShiftTransformer = (root) =>
+export const columnToVerticalBarTransform: JSCodeShiftTransformer = (root) => {
   root
     .find(j.ObjectProperty, { key: { name: 'cellRendererParams' } })
     .find(j.ObjectProperty, { key: { name: 'sparklineOptions' } })
@@ -14,3 +14,4 @@ export const columnToVerticalBarTransform: JSCodeShiftTransformer = (root) =>
       path.replace(j.objectProperty(j.identifier('type'), j.stringLiteral('bar')));
       path.insertAfter(j.objectProperty(j.identifier('direction'), j.stringLiteral(direction)));
     });
+};
diff --git a/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-crosshairs.ts b/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-crosshairs.ts
@@ -1,9 +1,10 @@
 import j from 'jscodeshift';
 import { JSCodeShiftTransformer } from '../../../plugins/jscodeshift';
 
-export const removeCrosshairs: JSCodeShiftTransformer = (root) =>
+export const removeCrosshairs: JSCodeShiftTransformer = (root) => {
   root
     .find(j.ObjectProperty, { key: { name: 'cellRendererParams' } })
     .find(j.ObjectProperty, { key: { name: 'sparklineOptions' } })
     .find(j.ObjectProperty, { key: { name: 'crosshairs' } })
     .forEach((path) => path.replace());
+};
diff --git a/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-types.ts b/packages/cli/src/codemods/transforms/transform-sparklines-options-v33-0/transformers/sparkline-types.ts
@@ -2,8 +2,9 @@ import j from 'jscodeshift';
 import { JSCodeShiftTransformer } from '../../../plugins/jscodeshift';
 import { newType, oldTypes } from './constants';
 
-export const replaceTypes: JSCodeShiftTransformer = (root) =>
+export const replaceTypes: JSCodeShiftTransformer = (root) => {
   root
     .find(j.TSTypeReference)
     .filter((path) => oldTypes.includes((path.value.typeName as any).name))
     .forEach((path) => path.replace(j.tsTypeReference(j.identifier(newType))));
+};
diff --git a/packages/cli/src/codemods/versions/34.0.0/README.md b/packages/cli/src/codemods/versions/34.0.0/README.md
@@ -0,0 +1,35 @@
+# 34.0.0
+
+Codemod for upgrading to [AG Grid v34.0.0](https://github.com/ag-grid/ag-grid/releases/tag/v34.0.0)
+
+## Usage
+
+```
+npx @ag-grid-devtools/cli migrate --to 34.0.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.0.0
+```
+
+Option 2: Add an existing source code transformation to this codemod release version:
+
+```
+pnpm run task:include-transform --version 34.0.0
+```
+
+### Add a test case
+
+Create a new unit test scenario for this version:
+
+```
+pnpm run task:create-test --type version --target 34.0.0
+```
diff --git a/packages/cli/src/codemods/versions/34.0.0/__fixtures__/scenarios/.gitignore b/packages/cli/src/codemods/versions/34.0.0/__fixtures__/scenarios/.gitignore
diff --git a/packages/cli/src/codemods/versions/34.0.0/codemod.test.ts b/packages/cli/src/codemods/versions/34.0.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.0.0/codemod.ts b/packages/cli/src/codemods/versions/34.0.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_0_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.0.0/manifest.ts b/packages/cli/src/codemods/versions/34.0.0/manifest.ts
@@ -0,0 +1,11 @@
+import { type TransformManifest, type VersionManifest } from '@ag-grid-devtools/types';
+
+const transforms: Array<TransformManifest> = [];
+
+const manifest: VersionManifest = {
+  version: '34.0.0',
+  codemodPath: 'versions/34.0.0',
+  transforms,
+};
+
+export default manifest;
diff --git a/packages/cli/src/codemods/versions/34.0.0/transforms.ts b/packages/cli/src/codemods/versions/34.0.0/transforms.ts
@@ -0,0 +1,5 @@
+import { type AstCliContext, type AstTransform } from '@ag-grid-devtools/ast';
+
+const transforms: Array<AstTransform<AstCliContext>> = [];
+
+export default transforms;
diff --git a/packages/cli/src/codemods/versions/manifest.ts b/packages/cli/src/codemods/versions/manifest.ts
@@ -20,6 +20,8 @@ import v33_2_0 from './33.2.0/manifest';
 
 import v33_3_0 from './33.3.0/manifest';
 
+import v34_0_0 from './34.0.0/manifest';
+
 const versions: Array<VersionManifest> = [
   v31_0_0,
   v31_1_0,
@@ -31,6 +33,7 @@ const versions: Array<VersionManifest> = [
   v33_1_0,
   v33_2_0,
   v33_3_0,
+  v34_0_0,
 ];
 
 export default versions;
diff --git a/packages/cli/src/test/e2e/gitignore-simple/gitignore-simple.test.ts b/packages/cli/src/test/e2e/gitignore-simple/gitignore-simple.test.ts
@@ -9,7 +9,7 @@ test(
   async () => {
     await env.init();
     await cli(
-      ['migrate', '--allow-untracked', '--from=30.0.0', '--to=33', '--non-interactive'],
+      ['migrate', '--allow-untracked', '--from=30.0.0', '--to=34', '--non-interactive'],
       env.cliOptions,
     );
 
diff --git a/packages/codemod-utils/src/transform/js.ts b/packages/codemod-utils/src/transform/js.ts
@@ -65,11 +65,11 @@ function transformJsFile<S>(
   const transformContext: AstTransformContext<AstCliContext> = {
     filename,
     opts: {
-      warn(node: NodePath<AstNode> | null, message: string) {
+      warn(node, message) {
         const error = createSourceCodeError(node, message);
         uniqueErrors.set(error.message, { error, fatal: false });
       },
-      fail(node: NodePath<AstNode> | null, message: string) {
+      fail(node, message) {
         const error = createSourceCodeError(node, message);
         uniqueErrors.set(error.message, { error, fatal: true });
       },
@@ -99,6 +99,14 @@ function transformJsFile<S>(
   };
 }
 
-function createSourceCodeError(node: NodePath<AstNode> | null, message: string): Error {
-  return node ? node.buildCodeFrameError(message) : new SyntaxError(message);
+function createSourceCodeError(node: NodePath<AstNode> | Error | null, message: string): Error {
+  if (!node) {
+    return new SyntaxError(message);
+  }
+
+  if ('hub' in node) {
+    return node.buildCodeFrameError(message);
+  }
+
+  return node;
 }
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/<%= filename %>.test.ts b/packages/codemods-tasks/templates/plugin-jscodeshift/<%= filename %>.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 <%= identifier %> from '.';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+describe(<%= identifier %>, () => {
+  const scenariosPath = join(__dirname, './__fixtures__/scenarios');
+  loadTransformScenarios(scenariosPath, {
+    transforms: [<%= identifier %>],
+    vitest: { describe, expect, test, onTestFinished },
+  });
+});
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/README.md b/packages/codemods-tasks/templates/plugin-jscodeshift/README.md
@@ -0,0 +1,3 @@
+# jscodeshift Plugin
+
+The `jscodeshift` plugin is a tool used for running codemods over JavaScript and TypeScript codebases. It leverages the `jscodeshift` library, which provides a simple API for transforming code using the power of abstract syntax trees (ASTs).
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/input.js b/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/input.js
@@ -0,0 +1,9 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.helloWorld();
+gridApi?.goodbyeWorld();
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.errors.cjs b/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.errors.cjs
@@ -0,0 +1,6 @@
+module.exports = [
+  new SyntaxError(`This method has been deprecated
+
+> | gridApi.goodbyeWorld();
+  | ^^^^^^^^^^^^^^^^^^^^^^`),
+];
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.js b/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.js
@@ -0,0 +1,9 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.sayHello("world");
+gridApi?.goodbyeWorld();
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.warnings.cjs b/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/output.warnings.cjs
@@ -0,0 +1 @@
+module.exports = [];
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/scenario.json b/packages/codemods-tasks/templates/plugin-jscodeshift/__fixtures__/scenarios/hello-world/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/codemods-tasks/templates/plugin-jscodeshift/index.ts b/packages/codemods-tasks/templates/plugin-jscodeshift/index.ts
@@ -0,0 +1 @@
+export * from './transforms';
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/manifest.ts b/packages/codemods-tasks/templates/plugin-jscodeshift/manifest.ts
@@ -0,0 +1,8 @@
+import { type TransformManifest } from '@ag-grid-devtools/types';
+
+const manifest: TransformManifest = {
+  name: '<%= name %>',
+  description: '<%= description %>',
+};
+
+export default manifest;
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/plugin.json b/packages/codemods-tasks/templates/plugin-jscodeshift/plugin.json
@@ -0,0 +1,4 @@
+{
+  "name": "JSCodeshift",
+  "description": "Transform using JSCodeshift"
+}
diff --git a/packages/codemods-tasks/templates/plugin-jscodeshift/transforms/index.ts b/packages/codemods-tasks/templates/plugin-jscodeshift/transforms/index.ts

Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ export interface FsContext extends TransformContext {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`export interface AstCliContext extends FsContext {`
`50`		`- warn(node: NodePath<AstNode> \| null, message: string): void;`
`51`		`- fail(node: NodePath<AstNode> \| null, message: string): void;`
	`50`	`+ warn(node: NodePath<AstNode> \| Error \| null, message: string): void;`
	`51`	`+ fail(node: NodePath<AstNode> \| Error \| null, message: string): void;`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`export type AstTransformResult = {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "@ag-grid-devtools/cli",`
`4`		`- "version": "33.3.0",`
	`4`	`+ "version": "34.0.0",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"description": "AG Grid developer toolkit",`
`7`	`7`	`"author": "AG Grid <[email protected]>",`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ export const packageLicenseManager: JSCodeShiftTransformer = (root) => {`
`47`	`47`
`48`	`48`	`if (alreadyExists) {`
`49`	`49`	`// This package file already has a ModuleRegistry import so looks like it has already been transformed`
`50`		`- return root.toSource();`
	`50`	`+ return;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`const usingCharts: UsingCharts = process.env.AG_USING_CHARTS as any;`