zod-v3-to-v4 1.8.0 → 1.9.0

package/README.md

@@ -2,6 +2,7 @@
 
 [![NPM version](https://img.shields.io/npm/v/zod-v3-to-v4.svg?style=for-the-badge)](https://www.npmjs.com/package/zod-v3-to-v4)
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/nicoespeon/zod-v3-to-v4/ci.yml?style=for-the-badge)](https://github.com/nicoespeon/zod-v3-to-v4/actions/workflows/ci.yml)
+[![All Contributors](https://img.shields.io/github/all-contributors/nicoespeon/zod-v3-to-v4?color=ee8449&style=for-the-badge)](#contributors)
 
 This is a [codemod](https://martinfowler.com/articles/codemods-api-refactoring.html) (a tool that automatically transforms code) for migrating from [Zod](https://zod.dev/) v3 to v4.
 
@@ -13,7 +14,7 @@ The migration guide can be found at <https://zod.dev/v4/changelog>
 
 > This assumes you have [Node.js](https://nodejs.org/) installed.
 
-The first step for you is to upgrade your Zod version to v4. In doubt, check your `package.json`.
+The first step for you is to upgrade your Zod version to v4. In doubt, check your `package.json`. Note that if you're using Zod through Astro v6, you don't need to upgrade Zod manually.
 
 Then, you can use this codemod to automatically migrate your code from Zod v3 to v4 syntax.
 
@@ -92,3 +93,58 @@ Or interactively:
 pnpm playground:interactive
 # Then enter: playground/tsconfig.json
 ```
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://nicoespeon.com/"><img src="https://avatars0.githubusercontent.com/u/1094774?v=4?s=100" width="100px;" alt="Nicolas Carlo"/><br /><sub><b>Nicolas Carlo</b></sub></a><br /><a href="#ideas-nicoespeon" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=nicoespeon" title="Code">💻</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=nicoespeon" title="Documentation">📖</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/pulls?q=is%3Apr+reviewed-by%3Anicoespeon" title="Reviewed Pull Requests">👀</a> <a href="#question-nicoespeon" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://hideoo.dev"><img src="https://avatars.githubusercontent.com/u/494699?v=4?s=100" width="100px;" alt="HiDeoo"/><br /><sub><b>HiDeoo</b></sub></a><br /><a href="#ideas-HiDeoo" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=HiDeoo" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://contra.com"><img src="https://avatars.githubusercontent.com/u/973543?v=4?s=100" width="100px;" alt="Gajus Kuizinas"/><br /><sub><b>Gajus Kuizinas</b></sub></a><br /><a href="#ideas-gajus" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Loskir"><img src="https://avatars.githubusercontent.com/u/21295738?v=4?s=100" width="100px;" alt="Kirill Loskutov"/><br /><sub><b>Kirill Loskutov</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3ALoskir" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Schrubitteflau"><img src="https://avatars.githubusercontent.com/u/45637360?v=4?s=100" width="100px;" alt="Schrubitteflau"/><br /><sub><b>Schrubitteflau</b></sub></a><br /><a href="#ideas-Schrubitteflau" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=Schrubitteflau" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/umbrellasalesman02"><img src="https://avatars.githubusercontent.com/u/10819467?v=4?s=100" width="100px;" alt="Erik"/><br /><sub><b>Erik</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aumbrellasalesman02" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.einargudni.com"><img src="https://avatars.githubusercontent.com/u/17381009?v=4?s=100" width="100px;" alt="Einar Guðni Guðjónsson"/><br /><sub><b>Einar Guðni Guðjónsson</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aeinargudnig" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/DanUgbeye"><img src="https://avatars.githubusercontent.com/u/82518175?v=4?s=100" width="100px;" alt="Daniel Ugbeye"/><br /><sub><b>Daniel Ugbeye</b></sub></a><br /><a href="#ideas-DanUgbeye" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://firxworx.com"><img src="https://avatars.githubusercontent.com/u/24518234?v=4?s=100" width="100px;" alt="Kevin Firko"/><br /><sub><b>Kevin Firko</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Afirxworx" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/greg-sims"><img src="https://avatars.githubusercontent.com/u/110814147?v=4?s=100" width="100px;" alt="Greg Sims"/><br /><sub><b>Greg Sims</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Agreg-sims" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/PowerSupply"><img src="https://avatars.githubusercontent.com/u/622851?v=4?s=100" width="100px;" alt="PowerSupply"/><br /><sub><b>PowerSupply</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3APowerSupply" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/cfrerebeau"><img src="https://avatars.githubusercontent.com/u/768210?v=4?s=100" width="100px;" alt="Christophe Frèrebeau"/><br /><sub><b>Christophe Frèrebeau</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Acfrerebeau" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/aelligsen"><img src="https://avatars.githubusercontent.com/u/210378474?v=4?s=100" width="100px;" alt="aelligsen"/><br /><sub><b>aelligsen</b></sub></a><br /><a href="#ideas-aelligsen" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://nikmaxott.org"><img src="https://avatars.githubusercontent.com/u/8322965?v=4?s=100" width="100px;" alt="Nikolaus Z"/><br /><sub><b>Nikolaus Z</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Anikmaxott" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bj0rge"><img src="https://avatars.githubusercontent.com/u/3996102?v=4?s=100" width="100px;" alt="Bastien Jorge"/><br /><sub><b>Bastien Jorge</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Abj0rge" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://danf.ca/"><img src="https://avatars.githubusercontent.com/u/53399?v=4?s=100" width="100px;" alt="Daniel Friesen"/><br /><sub><b>Daniel Friesen</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Adantman" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/affeldt28"><img src="https://avatars.githubusercontent.com/u/45835050?v=4?s=100" width="100px;" alt="Marvin Affeldt"/><br /><sub><b>Marvin Affeldt</b></sub></a><br /><a href="#ideas-affeldt28" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://aqeelat.com"><img src="https://avatars.githubusercontent.com/u/5212744?v=4?s=100" width="100px;" alt="Abdullah Alaqeel"/><br /><sub><b>Abdullah Alaqeel</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aaqeelat" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/wonderWoman1408"><img src="https://avatars.githubusercontent.com/u/5628562?v=4?s=100" width="100px;" alt="Wonder Woman"/><br /><sub><b>Wonder Woman</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3AwonderWoman1408" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nzhiti"><img src="https://avatars.githubusercontent.com/u/57987532?v=4?s=100" width="100px;" alt="nzhiti"/><br /><sub><b>nzhiti</b></sub></a><br /><a href="#ideas-nzhiti" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lyricnz"><img src="https://avatars.githubusercontent.com/u/122371?v=4?s=100" width="100px;" alt="Simon Roberts"/><br /><sub><b>Simon Roberts</b></sub></a><br /><a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Alyricnz" title="Bug reports">🐛</a></td>
+    </tr>
+    <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>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

package/dist/collect-imports.js

@@ -1,16 +1,30 @@
 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 = [
+    "astro:content",
+    "astro:schema",
+];
+export const AstroZodModuleSpecifiers = [
+    AstroZodModuleSpecifier,
+    ...AstroDeprecatedZodModuleSpecifiers,
+];
+const zodModuleSpecifiers = ["zod", "zod/v3", ...AstroZodModuleSpecifiers];
 export function collectZodImportDeclarations(sourceFile) {
     return sourceFile
         .getImportDeclarations()
-        .filter((importDeclaration) => ["zod", "zod/v3"].includes(importDeclaration.getModuleSpecifierValue()));
+        .filter((importDeclaration) => zodModuleSpecifiers.includes(importDeclaration.getModuleSpecifierValue()));
 }
 export function getZodName(importDeclarations) {
-    const zodImport = importDeclarations[0]
-        ?.getNamedImports()
-        .find((namedImport) => namedImport.getName() === "z");
+    const zodImport = getZodImport(importDeclarations[0]);
     const zodImportNode = zodImport?.getAliasNode() ?? zodImport?.getNameNode();
     return zodImportNode?.getText() ?? "z";
 }
+export function getZodImport(importDeclaration) {
+    return importDeclaration
+        ?.getNamedImports()
+        .find((namedImport) => namedImport.getName() === "z");
+}
 export function collectZodReferences(importDeclarations) {
     return importDeclarations.flatMap((importDeclaration) => importDeclaration.getNamedImports().flatMap((namedImport) => {
         const namedNode = namedImport.getAliasNode() ?? namedImport.getNameNode();

package/dist/convert-astro-imports.js

@@ -0,0 +1,31 @@
+import { AstroDeprecatedZodModuleSpecifiers, AstroZodModuleSpecifier, getZodImport, } from "./collect-imports.js";
+export function convertAstroDeprecatedZodImports(importDeclarations) {
+    for (const declaration of importDeclarations) {
+        const zodImport = getZodImport(declaration);
+        if (!zodImport || !isDeprecatedAstroZodImport(declaration)) {
+            continue;
+        }
+        // Get the alias if any before removing the import.
+        const alias = zodImport.getAliasNode()?.getText();
+        // Remove the deprecated Astro Zod import.
+        zodImport.remove();
+        if (
+        // If no named imports remain…
+        declaration.getNamedImports().length === 0 &&
+            // And there is no default import…
+            !declaration.getDefaultImport()) {
+            // Remove the entire import declaration.
+            declaration.remove();
+        }
+        // Add a new import declaration for `astro/zod`.
+        declaration.getSourceFile().addImportDeclaration({
+            moduleSpecifier: AstroZodModuleSpecifier,
+            namedImports: [
+                { name: "z", alias: alias && alias !== "z" ? alias : undefined },
+            ],
+        });
+    }
+}
+function isDeprecatedAstroZodImport(declaration) {
+    return AstroDeprecatedZodModuleSpecifiers.includes(declaration.getModuleSpecifierValue());
+}

package/dist/migrate.js

@@ -1,6 +1,7 @@
 import { SyntaxKind } from "ts-morph";
 import { findRootExpression } from "./ast.js";
-import { collectZodImportDeclarations, collectZodReferences, getZodName, } from "./collect-imports.js";
+import { AstroZodModuleSpecifiers, 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";
 import { replaceDeletedTypes } from "./replace-deleted-types.js";
@@ -9,13 +10,18 @@ export function migrateZodV3ToV4(sourceFile, options = {}) {
     const importDeclarations = collectZodImportDeclarations(sourceFile);
     const zodName = getZodName(importDeclarations);
     importDeclarations.forEach((declaration) => {
-        if (declaration.getModuleSpecifier().getText() === "zod/v3") {
+        const specifier = declaration.getModuleSpecifierValue();
+        if (specifier === "zod/v3") {
             declaration.setModuleSpecifier("zod");
         }
         if (options.migrateImportDeclarations) {
             // Use `zod/v4` explicit import. Not needed for an actual migration.
             // Useful for testing, so we can have v3.25 and typecheck both v3 and v4
-            declaration.setModuleSpecifier("zod/v4");
+            // Astro re-exports don't need to be updated and don't have a v4
+            // dedicated export.
+            if (!AstroZodModuleSpecifiers.includes(specifier)) {
+                declaration.setModuleSpecifier("zod/v4");
+            }
         }
     });
     // Collect references before modifying imports
@@ -50,6 +56,7 @@ export function migrateZodV3ToV4(sourceFile, options = {}) {
     convertZodErrorToTreeifyError(sourceFile, zodName);
     convertZodErrorAddIssueToDirectPushes(sourceFile, zodName);
     renameZSchemaEnumToLowercase(sourceFile, zodName);
+    convertAstroDeprecatedZodImports(importDeclarations);
     return sourceFile.getFullText();
 }
 function renameZDefaultToZPrefault(node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-v3-to-v4",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Migrate Zod from v3 to v4",
   "keywords": [
     "zod",
@@ -52,6 +52,7 @@
     "lint-staged": "16.0.0",
     "prettier": "3.5.3",
     "prettier-plugin-curly": "0.3.1",
+    "prettier-plugin-organize-imports": "4.3.0",
     "prettier-plugin-packagejson": "2.5.10",
     "prettier-plugin-sh": "0.15.0",
     "rimraf": "6.0.1",