zod-v3-to-v4 1.9.0 → 1.11.0

package/README.md

@@ -131,6 +131,8 @@ pnpm playground:interactive
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/yann-combarnous"><img src="https://avatars.githubusercontent.com/u/39089766?v=4?s=100" width="100px;" alt="yann-combarnous"/><br /><sub><b>yann-combarnous</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Ayann-combarnous" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://adam.doussan.info"><img src="https://avatars.githubusercontent.com/u/26745150?v=4?s=100" width="100px;" alt="acdoussan"/><br /><sub><b>acdoussan</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aacdoussan" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://matsjfunke.com"><img src="https://avatars.githubusercontent.com/u/125814808?v=4?s=100" width="100px;" alt="Mats Julius Funke"/><br /><sub><b>Mats Julius Funke</b></sub></a><br /><a href="#ideas-matsjfunke" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/popfendi"><img src="https://avatars.githubusercontent.com/u/84185235?v=4?s=100" width="100px;" alt="popfendi"/><br /><sub><b>popfendi</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Apopfendi" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
   <tfoot>

package/dist/collect-imports.js

@@ -1,4 +1,4 @@
-import { SyntaxKind } from "ts-morph";
+import { SyntaxKind, } from "ts-morph";
 export const AstroZodModuleSpecifier = "astro/zod";
 // https://v6.docs.astro.build/en/guides/upgrade-to/v6/#deprecated-astroschema-and-z-from-astrocontent
 export const AstroDeprecatedZodModuleSpecifiers = [
@@ -36,3 +36,47 @@ export function collectZodReferences(importDeclarations) {
             .filter((node) => node !== namedNode);
     }));
 }
+/**
+ * Collect references to variables that are derived from Zod schemas.
+ *
+ * For example, given:
+ *
+ *     const baseSchema = z.string().refine(...);
+ *     const constrainedSchema = baseSchema.refine(...);
+ *
+ * This function will return references to `baseSchema` (like the one used
+ * in `constrainedSchema`), so we can also migrate those.
+ */
+export function collectDerivedZodSchemaReferences(zodReferences) {
+    const derivedReferences = [];
+    const visited = new Set();
+    function collectFromReferences(refs) {
+        for (const ref of refs) {
+            // Find the variable declaration that contains this Zod reference
+            const variableDeclaration = ref.getFirstAncestorByKind(SyntaxKind.VariableDeclaration);
+            if (!variableDeclaration) {
+                continue;
+            }
+            const variableName = variableDeclaration.getName();
+            if (visited.has(variableName)) {
+                continue;
+            }
+            visited.add(variableName);
+            // Get the identifier node for the variable name
+            const nameNode = variableDeclaration.getNameNode();
+            if (!nameNode.isKind(SyntaxKind.Identifier)) {
+                continue;
+            }
+            // Find all references to this variable (excluding the declaration itself)
+            const variableReferences = nameNode
+                .findReferencesAsNodes()
+                .filter((node) => node !== nameNode)
+                .filter((node) => node.isKind(SyntaxKind.Identifier));
+            derivedReferences.push(...variableReferences);
+            // Recursively collect references from these derived schemas
+            collectFromReferences(variableReferences);
+        }
+    }
+    collectFromReferences(zodReferences);
+    return derivedReferences;
+}

package/dist/convert-name-to-top-level-api.js

@@ -123,7 +123,10 @@ export function convertZArrayPatternsToTopLevelApi(node, zodName) {
     getCallExpressionsToConvert(node, {
         oldName,
         names,
-    }).forEach((callExpression) => {
+    })
+        // Start from the deepest, otherwise we can't get info from removed nodes
+        .reverse()
+        .forEach((callExpression) => {
         // Remove deprecated names from the chain
         callExpression
             .getDescendantsOfKind(SyntaxKind.PropertyAccessExpression)

package/dist/convert-zod-errors.js

@@ -187,6 +187,13 @@ export function convertZodErrorAddIssueToDirectPushes(sourceFile, zodName) {
             : argument.getText();
         expression.replaceWithText(`${caller}.issues.push(${newArgument})`);
     });
+    sourceFile
+        .getDescendantsOfKind(SyntaxKind.PropertyAccessExpression)
+        .filter((expression) => isZodReference(zodName, ["ZodType", "ZodError"], expression))
+        .filter((expression) => expression.getName() === "errors")
+        .forEach((expression) => {
+        expression.getNameNode().replaceWithText("issues");
+    });
 }
 function convertZodIssueToV4(node) {
     if (node.isKind(SyntaxKind.ArrayLiteralExpression)) {

package/dist/index.js

@@ -2,8 +2,10 @@
 import { cancel, confirm, intro, isCancel, log, outro, progress, text, } from "@clack/prompts";
 import { exec } from "node:child_process";
 import * as fs from "node:fs";
+import * as path from "node:path";
 import { promisify } from "node:util";
 import { Project } from "ts-morph";
+import z from "zod";
 import { migrateZodV3ToV4 } from "./migrate.js";
 const execAsync = promisify(exec);
 intro(`🏗️  Let's migrate Zod from v3 to v4`);
@@ -56,7 +58,26 @@ if (isCancel(tsConfigFilePath)) {
 await runMigration(tsConfigFilePath);
 async function runMigration(tsConfigFilePath) {
     const project = new Project({ tsConfigFilePath });
-    const filesToProcess = project.getSourceFiles();
+    let filesToProcess = project.getSourceFiles();
+    const references = getProjectReferences(tsConfigFilePath);
+    // If we can only find refs, we are probably in a monorepo setup.
+    // Ask the user if they want to migrate all the references.
+    const isMonorepoRoot = filesToProcess.length === 0 && references.length > 0;
+    if (isMonorepoRoot) {
+        const shouldFollowRefs = await confirm({
+            message: `Found ${references.length} project reference(s). Migrate all referenced packages?`,
+        });
+        if (isCancel(shouldFollowRefs)) {
+            cancel("Migration cancelled.");
+            process.exit(0);
+        }
+        if (shouldFollowRefs) {
+            for (const refPath of references) {
+                project.addSourceFilesFromTsConfig(refPath);
+            }
+            filesToProcess = project.getSourceFiles();
+        }
+    }
     let processedFilesCount = 0;
     const progressBar = progress({ max: filesToProcess.length });
     progressBar.start("Processing files...");
@@ -85,6 +106,46 @@ async function runMigration(tsConfigFilePath) {
 
 ℹ️  If the migration missed something or did something wrong, please report it at https://github.com/nicoespeon/zod-v3-to-v4/issues`);
 }
+function getProjectReferences(tsConfigFilePath) {
+    // Use Zod to parse the tsconfig.json file for interesting fields.
+    const tsConfigWithRefs = z
+        .object({
+        references: z
+            .array(z.object({
+            path: z.string().nullable(),
+        }))
+            .default([]),
+    })
+        .passthrough();
+    try {
+        const content = fs.readFileSync(tsConfigFilePath, "utf-8");
+        const config = tsConfigWithRefs.parse(JSON.parse(content));
+        const tsConfigDir = path.dirname(tsConfigFilePath);
+        return config.references
+            .map((ref) => {
+            if (!ref.path)
+                return null;
+            const refDir = path.resolve(tsConfigDir, ref.path);
+            // Scenario: `ref.path` points directly to the tsconfig file
+            if (ref.path.endsWith(".json") && fs.existsSync(refDir)) {
+                return refDir;
+            }
+            // Otherwise, look for `tsconfig.json` in the referenced directory.
+            // We don't support other names yet. Workaround is to reference
+            // the tsconfig path or directly run the codemod with the path
+            // to the tsconfig you want to migrate.
+            const refTsConfig = path.join(refDir, "tsconfig.json");
+            if (fs.existsSync(refTsConfig)) {
+                return refTsConfig;
+            }
+            return null;
+        })
+            .filter((p) => p !== null);
+    }
+    catch (error) {
+        return [];
+    }
+}
 function validateTsConfigPath(path) {
     if (!path.endsWith(".json")) {
         return {

package/dist/migrate.js

@@ -1,6 +1,6 @@
 import { SyntaxKind } from "ts-morph";
 import { findRootExpression } from "./ast.js";
-import { AstroZodModuleSpecifiers, collectZodImportDeclarations, collectZodReferences, getZodName, } from "./collect-imports.js";
+import { AstroZodModuleSpecifiers, collectDerivedZodSchemaReferences, collectZodImportDeclarations, collectZodReferences, getZodName, } from "./collect-imports.js";
 import { convertAstroDeprecatedZodImports } from "./convert-astro-imports.js";
 import { convertZArrayPatternsToTopLevelApi, convertZCoercePatternsToTopLevelApi, convertZFunctionPatternsToTopLevelApi, convertZNumberPatternsToZInt, convertZObjectPatternsToTopLevelApi, convertZRecordPatternsToTopLevelApi, convertZStringPatternsToTopLevelApi, } from "./convert-name-to-top-level-api.js";
 import { convertDeprecatedErrorKeysToErrorFunction, convertErrorMapToErrorFunction, convertMessageKeyToError, convertZodErrorAddIssueToDirectPushes, convertZodErrorToTreeifyError, } from "./convert-zod-errors.js";
@@ -26,8 +26,9 @@ export function migrateZodV3ToV4(sourceFile, options = {}) {
     });
     // Collect references before modifying imports
     const zodReferences = collectZodReferences(importDeclarations);
+    const derivedReferences = collectDerivedZodSchemaReferences(zodReferences);
     replaceDeletedTypes(importDeclarations, zodReferences);
-    zodReferences.forEach((node) => {
+    [...zodReferences, ...derivedReferences].forEach((node) => {
         if (node.wasForgotten()) {
             return;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-v3-to-v4",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Migrate Zod from v3 to v4",
   "keywords": [
     "zod",
@@ -33,6 +33,7 @@
     "format-check": "prettier . --list-different",
     "playground": "pnpm playground:interactive playground/tsconfig.json",
     "playground:interactive": "node --experimental-strip-types --disable-warning=ExperimentalWarning src/index.ts",
+    "playground:monorepo": "pnpm playground:interactive playground-monorepo/tsconfig.json",
     "prepare": "husky",
     "prepublishOnly": "pnpm typecheck && pnpm test && pnpm build",
     "test": "vitest run",