KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #codex #typescript #developer-tools #ai-agents #deepseek-harness #claude-code #ai-agent #cli #react #mcp

zod-v3-to-v4

★ 108 Open GitHub ↗

A codemod to migrate from Zod v3 to v4

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Zod v3 to v4

[![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)](https://raw.githubusercontent.com/nicoespeon/zod-v3-to-v4/main/)

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.

The migration guide can be found at <https://zod.dev/v4/changelog>

![zod-v3-to-v4-demo](https://raw.githubusercontent.com/nicoespeon/zod-v3-to-v4/main/zod-v3-to-v4-demo.gif)

## Using this codemod

> 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`. 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.

This codemod also migrates `.vue` files containing Zod schemas.

### Interactive CLI

You can run it with the following command:

```bash
npx zod-v3-to-v4
```

It will ask you for the path to your `tsconfig.json` file, and then it will go through all your files and migrate Zod v3 code to v4.

### Non-interactive CLI

Alternatively, you can pass the path to your `tsconfig.json` file as an argument:

```bash
npx zod-v3-to-v4 path/to/your/tsconfig.json
```

This is useful if you ever need to run the codemod in script (e.g. in a CI pipeline).

### Installing it as a package

You can also install it as a package and run it from your project:

```bash
npm install -ED zod-v3-to-v4
```

And then run it with:

```bash
npx zod-v3-to-v4
```

### Reporting issues

If the codemod missed something or did something wrong, please [open an issue](https://github.com/nicoespeon/zod-v3-to-v4/issues).

## Contributing

This project uses [node.js](https://nodejs.org/en/) and [pnpm](https://pnpm.io/). To get started, run:

```bash
pnpm install
```

To run the tests, run:

```bash
pnpm test
```

We use [ts-morph](https://ts-morph.com) to parse and transform the code.

Useful links:

- [ts-morph](https://ts-morph.com)
- [TS AST viewer](https://ts-ast-viewer.com/)
- [vitest](https://vitest.dev)
- [Zod v4 migration guide](https://zod.dev/v4/changelog)

### Playground

If you want to test the codemod from CLI, you can use the `playground` folder. It contains a `tsconfig.json` file and some sample TypeScript files with Zod v3 code. You can run the codemod on these files with:

```bash
pnpm playground
```

Or interactively:

```bash
pnpm playground:interactive
# Then enter: playground/tsconfig.json
```

## Contributors

<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"/> Nicolas Carlo</a> <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"/> HiDeoo</a> <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"/> Gajus Kuizinas</a> <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"/> Kirill Loskutov</a> <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"/> Schrubitteflau</a> <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"/> Erik</a> <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"/> Einar Guðni Guðjónsson</a> <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"/> Daniel Ugbeye</a> <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"/> Kevin Firko</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Afirxworx" title="Bug reports">🐛</a> <a href="#ideas-firxworx" title="Ideas, Planning, & Feedback">🤔</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"/> Greg Sims</a> <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"/> PowerSupply</a> <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"/> Christophe Frèrebeau</a> <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"/> aelligsen</a> <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"/> Nikolaus Z</a> <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"/> Bastien Jorge</a> <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"/> Daniel Friesen</a> <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"/> Marvin Affeldt</a> <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"/> Abdullah Alaqeel</a> <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"/> Wonder Woman</a> <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"/> nzhiti</a> <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"/> Simon Roberts</a> <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"/> yann-combarnous</a> <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"/> acdoussan</a> <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"/> Mats Julius Funke</a> <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"/> popfendi</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Apopfendi" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/luis-azevedo-visma"><img src="https://avatars.githubusercontent.com/u/149402066?v=4?s=100" width="100px;" alt="Luís Azevedo"/> Luís Azevedo</a> <a href="#ideas-luis-azevedo-visma" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aluis-azevedo-visma" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://florian-lefebvre.dev"><img src="https://avatars.githubusercontent.com/u/69633530?v=4?s=100" width="100px;" alt="Florian Lefebvre"/> Florian Lefebvre</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Aflorian-lefebvre" title="Bug reports">🐛</a> <a href="#ideas-florian-lefebvre" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/pulls?q=is%3Apr+reviewed-by%3Aflorian-lefebvre" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://www.robertcooper.me"><img src="https://avatars.githubusercontent.com/u/16786990?v=4?s=100" width="100px;" alt="Robert Cooper"/> Robert Cooper</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Arobertcoopercode" title="Bug reports">🐛</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://cgi.cse.unsw.edu.au/~cs1531"><img src="https://avatars.githubusercontent.com/u/86177399?v=4?s=100" width="100px;" alt="Khiet Tam Nguyen"/> Khiet Tam Nguyen</a> <a href="#ideas-nktnet1" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://nook.sh"><img src="https://avatars.githubusercontent.com/u/19751938?v=4?s=100" width="100px;" alt="Neil Richter"/> Neil Richter</a> <a href="#ideas-noook" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/jboga"><img src="https://avatars.githubusercontent.com/u/1196151?v=4?s=100" width="100px;" alt="Jeremy Bogatirsky"/> Jeremy Bogatirsky</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=jboga" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Akkuma"><img src="https://avatars.githubusercontent.com/u/342889?v=4?s=100" width="100px;" alt="Greg W"/> Greg W</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3AAkkuma" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/paulrudy"><img src="https://avatars.githubusercontent.com/u/1110792?v=4?s=100" width="100px;" alt="paulrudy"/> paulrudy</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Apaulrudy" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/dukejeffrie"><img src="https://avatars.githubusercontent.com/u/688490?v=4?s=100" width="100px;" alt="Tiago tms Silveira"/> Tiago tms Silveira</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Adukejeffrie" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mhzendehpey"><img src="https://avatars.githubusercontent.com/u/51740060?v=4?s=100" width="100px;" alt="M. Hossein Zendehpey"/> M. Hossein Zendehpey</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Amhzendehpey" title="Bug reports">🐛</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://palerdot.in"><img src="https://avatars.githubusercontent.com/u/4299398?v=4?s=100" width="100px;" alt="Arun Kumar"/> Arun Kumar</a> <a href="#ideas-palerdot" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://bardiharborow.com"><img src="https://avatars.githubusercontent.com/u/1073681?v=4?s=100" width="100px;" alt="Bardi Harborow"/> Bardi Harborow</a> <a href="#ideas-bardiharborow" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Abardiharborow" title="Bug reports">🐛</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/commits?author=bardiharborow" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/marinaanisimova/"><img src="https://avatars.githubusercontent.com/u/62561106?v=4?s=100" width="100px;" alt="Marina"/> Marina</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Awillarion" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/shurane"><img src="https://avatars.githubusercontent.com/u/541433?v=4?s=100" width="100px;" alt="Ehtesh Choudhury"/> Ehtesh Choudhury</a> <a href="https://github.com/nicoespeon/zod-v3-to-v4/issues?q=author%3Ashurane" 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>

zod-v3-to-v4

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README