support error and warning messages in jscodeshift-based transforms

Author: eliasmalik

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 = {

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);
+      }
+    },
   });
 };

packages/cli/src/codemods/transforms/transform-grid-api-methods-v34-0/__fixtures__/scenarios/autoSizeColumns/input.js

@@ -7,8 +7,10 @@ const gridApi = createGrid(document.body, {
 
 const array = ['bar'];
 const flag = true;
+const allArgs = [['baz'], false];
 
 gridApi.autoSizeColumns(['foo'], true);
 gridApi?.autoSizeColumns(['foo'], false);
 gridApi.autoSizeColumns(array, flag);
 gridApi.autoSizeColumns(array);
+gridApi.autoSizeColumns(...allArgs);

packages/cli/src/codemods/transforms/transform-grid-api-methods-v34-0/__fixtures__/scenarios/autoSizeColumns/output.errors.cjs

@@ -1 +1,6 @@
-module.exports = [];
+module.exports = [
+    new SyntaxError(`Cannot support spread arguments
+
+> | gridApi.autoSizeColumns(...allArgs);
+  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`)
+];

packages/cli/src/codemods/transforms/transform-grid-api-methods-v34-0/__fixtures__/scenarios/autoSizeColumns/output.js

@@ -7,6 +7,7 @@ const gridApi = createGrid(document.body, {
 
 const array = ['bar'];
 const flag = true;
+const allArgs = [['baz'], false];
 
 gridApi.autoSizeColumns({
   colIds: ['foo'],
@@ -23,3 +24,4 @@ gridApi.autoSizeColumns({
 gridApi.autoSizeColumns({
   colIds: array
 });
+gridApi.autoSizeColumns(...allArgs);

packages/cli/src/codemods/transforms/transform-grid-api-methods-v34-0/jscodeshift.adapter.ts

@@ -1,7 +1,10 @@
 import j from 'jscodeshift';
-import { JSCodeShiftTransformer } from '../jscodeshift.adapter';
+import { ErrorSpec, JSCodeShiftTransformer } from '../../../plugins/jscodeshift';
+
+export const transformAutoSizeColumnsArguments: JSCodeShiftTransformer = (root) => {
+  const errors: ErrorSpec[] = [];
+  const warnings: ErrorSpec[] = [];
 
-export const transformAutoSizeColumnsArguments: JSCodeShiftTransformer = (root) =>
   root
     .find(j.CallExpression, {
       callee: {
@@ -14,7 +17,7 @@ export const transformAutoSizeColumnsArguments: JSCodeShiftTransformer = (root)
       const args = path.node.arguments;
 
       if (args.some((a) => j.SpreadElement.check(a))) {
-        // can't support spread arguments
+        errors.push({ path, message: 'Cannot support spread arguments' });
         return;
       }
 
@@ -31,7 +34,13 @@ export const transformAutoSizeColumnsArguments: JSCodeShiftTransformer = (root)
       path.node.arguments = [j.objectExpression(properties)];
     });
 
-export const transformAutoSizeAllColumnsArguments: JSCodeShiftTransformer = (root) =>
+  return { errors, warnings };
+};
+
+export const transformAutoSizeAllColumnsArguments: JSCodeShiftTransformer = (root) => {
+  const errors: ErrorSpec[] = [];
+  const warnings: ErrorSpec[] = [];
+
   root
     .find(j.CallExpression, {
       callee: {
@@ -48,7 +57,7 @@ export const transformAutoSizeAllColumnsArguments: JSCodeShiftTransformer = (roo
       }
 
       if (args.some((a) => j.SpreadElement.check(a))) {
-        // can't support spread arguments
+        errors.push({ path, message: 'Cannot support spread arguments' });
         return;
       }
 
@@ -59,3 +68,6 @@ export const transformAutoSizeAllColumnsArguments: JSCodeShiftTransformer = (roo
 
       path.node.arguments = [j.objectExpression(properties)];
     });
+
+  return { errors, warnings };
+};

packages/cli/src/codemods/transforms/transform-grid-api-methods-v34-0/transforms/index.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;
 }

packages/codemod-utils/src/transform/js.ts

@@ -1,2 +1 @@
-export * from './jscodeshift.adapter';
 export * from './transforms';