Merge pull request #1273 from paoloricciuti/other-codemod-fixes

feat: graceful multiple imports exit + `transform` and `refine`

Author: fabian-hiller

codemod/zod-to-valibot/__testfixtures__/multiple-imports-from-zod/input.ts

@@ -0,0 +1,3 @@
+import { z, ZodAnyType } from "zod";
+
+const Schema1 = z.string();

codemod/zod-to-valibot/__testfixtures__/multiple-imports-from-zod/output.ts

@@ -0,0 +1,4 @@
+/* @valibot-migrate: unable to transform imports from Zod to Valibot: Expected exactly one import specifier from "zod" or "zod/v4". */
+import { z, ZodAnyType } from "zod";
+
+const Schema1 = z.string();

codemod/zod-to-valibot/__testfixtures__/refine/input.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+
+// Basic refine
+const Schema1 = z.number().refine((val) => val < 100, "Must be less then 100");
+
+// Refine with string schema
+const Schema2 = z.string().refine((val) => val.length > 0, "Required");
+
+// Refine after validator
+const Schema3 = z.number().min(0).refine((val) => val % 2 === 0, "Must be even");
+
+// Multiple refines
+const Schema4 = z.string().refine((val) => val.length > 3).refine((val) => val.includes("@"));
+
+// Refine with complex condition
+const Schema5 = z.object({ name: z.string() }).refine((data) => data.name !== "admin", {
+  message: "Cannot use admin"
+});
+
+// Refine on linked schema
+const BaseSchema = z.string();
+const RefinedSchema = BaseSchema.refine((val) => val.trim().length > 0);

codemod/zod-to-valibot/__testfixtures__/refine/output.ts

@@ -0,0 +1,27 @@
+import * as v from "valibot";
+
+// Basic refine
+const Schema1 = v.pipe(v.number(), v.check((val) => val < 100, "Must be less then 100"));
+
+// Refine with string schema
+const Schema2 = v.pipe(v.string(), v.check((val) => val.length > 0, "Required"));
+
+// Refine after validator
+const Schema3 = v.pipe(v.number(), v.minValue(0), v.check((val) => val % 2 === 0, "Must be even"));
+
+// Multiple refines
+const Schema4 = v.pipe(
+  v.string(),
+  v.check((val) => val.length > 3),
+  v.check((val) => val.includes("@"))
+);
+
+// Refine with complex condition
+const Schema5 = v.pipe(
+  v.object({ name: v.string() }),
+  v.check((data) => data.name !== "admin", "Cannot use admin")
+);
+
+// Refine on linked schema
+const BaseSchema = v.string();
+const RefinedSchema = v.pipe(BaseSchema, v.check((val) => val.trim().length > 0));

codemod/zod-to-valibot/__testfixtures__/transform/input.ts

@@ -0,0 +1,26 @@
+import { z } from "zod";
+
+// Basic transform
+const Schema1 = z.number().transform((val) => val * 2);
+
+// Transform with string schema
+const Schema2 = z.string().transform((val) => val.toUpperCase());
+
+// Chained transform with validator
+const Schema3 = z.number().min(0).transform((val) => val + 1);
+
+// Transform after validator chain
+const Schema4 = z.string().email().transform((val) => `Email: ${val}`);
+
+// Multiple transforms
+const Schema5 = z.number().transform((val) => val * 2).transform((val) => val + 10);
+
+// Transform with complex function
+const Schema6 = z.object({ name: z.string() }).transform((data) => ({
+  ...data,
+  displayName: data.name.toUpperCase()
+}));
+
+// Transform on linked schema
+const BaseSchema = z.string();
+const TransformedSchema = BaseSchema.transform((val) => val.trim());

codemod/zod-to-valibot/__testfixtures__/transform/output.ts

@@ -0,0 +1,26 @@
+import * as v from "valibot";
+
+// Basic transform
+const Schema1 = v.pipe(v.number(), v.transform((val) => val * 2));
+
+// Transform with string schema
+const Schema2 = v.pipe(v.string(), v.transform((val) => val.toUpperCase()));
+
+// Chained transform with validator
+const Schema3 = v.pipe(v.number(), v.minValue(0), v.transform((val) => val + 1));
+
+// Transform after validator chain
+const Schema4 = v.pipe(v.string(), v.email(), v.transform((val) => `Email: ${val}`));
+
+// Multiple transforms
+const Schema5 = v.pipe(v.number(), v.transform((val) => val * 2), v.transform((val) => val + 10));
+
+// Transform with complex function
+const Schema6 = v.pipe(v.object({ name: v.string() }), v.transform((data) => ({
+  ...data,
+  displayName: data.name.toUpperCase()
+})));
+
+// Transform on linked schema
+const BaseSchema = v.string();
+const TransformedSchema = v.pipe(BaseSchema, v.transform((val) => val.trim()));

codemod/zod-to-valibot/src/test-setup.test.ts

@@ -26,6 +26,7 @@ defineTests(transform, [
   'intersection-schema',
   'literal-schema',
   'map-schema',
+  'multiple-imports-from-zod',
   'named-import',
   'named-import-with-alias',
   'named-import-with-specific-alias',
@@ -55,6 +56,7 @@ defineTests(transform, [
   'parsing',
   'readonly',
   'record-schema',
+  'refine',
   'schema-chain',
   'schema-options',
   'set-schema',
@@ -63,6 +65,7 @@ defineTests(transform, [
   'specific-namespace-import',
   'string-validation-methods',
   'symbol-schema',
+  'transform',
   'tuple-schema',
   'type-inference',
   'undefined-schema',

codemod/zod-to-valibot/src/transform/imports/imports.ts

@@ -3,6 +3,7 @@ import j, { type Collection } from 'jscodeshift';
 type TransformImportsReturn =
   | {
       conclusion: 'skip' | 'unsuccessful';
+      cause: string;
       valibotIdentifier?: undefined;
     }
   | { conclusion: 'successful'; valibotIdentifier: string };
@@ -20,13 +21,15 @@ export function transformImports(
   if (importNodes.length !== 1) {
     return {
       conclusion: importNodes.length === 0 ? 'skip' : 'unsuccessful',
+      cause: 'Expected exactly one import statement from "zod" or "zod/v4".',
     };
   }
   // Check the number of specifiers is exactly one
   const importSpecifiers = importNodes[0].specifiers;
   if (importSpecifiers?.length !== 1) {
     return {
       conclusion: 'unsuccessful',
+      cause: 'Expected exactly one import specifier from "zod" or "zod/v4".',
     };
   }
   // Obtain the identifier
@@ -35,6 +38,7 @@ export function transformImports(
   if (typeof zodIdentifier !== 'string') {
     return {
       conclusion: 'unsuccessful',
+      cause: 'Expected the import specifier to have a local name.',
     };
   }
   const isZodIdentifierZ = zodIdentifier === 'z';

codemod/zod-to-valibot/src/transform/index.ts

@@ -9,9 +9,20 @@ const transform: Transform = (fileInfo, api) => {
   // ------------ Imports ------------
   const transformImportsResult = transformImports(root);
   if (transformImportsResult.conclusion !== 'successful') {
-    return transformImportsResult.conclusion === 'skip'
-      ? undefined
-      : root.toSource();
+    if (transformImportsResult.conclusion === 'unsuccessful') {
+      const node = root.get().node;
+      // Add comment indicating unsuccessful transformation
+      node.comments ??= [];
+      node.comments.unshift(
+        j.commentBlock(
+          ` @valibot-migrate: unable to transform imports from Zod to Valibot: ${transformImportsResult.cause} `,
+          true,
+          false
+        )
+      );
+      return root.toSource();
+    }
+    return undefined;
   }
   const valibotIdentifier = transformImportsResult.valibotIdentifier;
 

codemod/zod-to-valibot/src/transform/schemas-and-links/constants.ts

@@ -153,13 +153,15 @@ export const ZOD_METHODS = [
   'partial',
   'passthrough',
   'pick',
+  'refine',
   'required',
   'rest',
   'safeParse',
   'safeParseAsync',
   'strict',
   'strip',
   'spa',
+  'transform',
   'unwrap',
 ] as const;