# prism-prisma-zod-generator > Prisma 2+ generator to emit Zod schemas from your Prisma schema Latest version **0.7.1** (published 2022-12-10) · MIT license · 0 weekly downloads ## Install ```sh npm install prism-prisma-zod-generator pnpm add prism-prisma-zod-generator yarn add prism-prisma-zod-generator bun add prism-prisma-zod-generator ``` Provides the command `prisma-zod-generator`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.7.1 | | Published | 2022-12-10 | | First published | 2022-11-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 120.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 830 | | Author | Omar Dulaimi | | Maintainers | sony1004 | | Keywords | prisma, prisma-client, prisma-schema, zod, prisma-generator, prisma-zod-generator | ## Links - npm: https://www.npmjs.com/package/prism-prisma-zod-generator - Repository: https://github.com/omar-dulaimi/prisma-zod-generator - Homepage: https://github.com/omar-dulaimi/prisma-zod-generator#readme - Issues: https://github.com/omar-dulaimi/prisma-zod-generator/issues - npm.io page: https://npm.io/package/prism-prisma-zod-generator ## Dependencies (6) - [zod](https://npm.io/package/zod.md) ^3.18.0 - [tslib](https://npm.io/package/tslib.md) ^2.4.0 - [prettier](https://npm.io/package/prettier.md) ^2.7.1 - [@prisma/client](https://npm.io/package/@prisma/client.md) ^4.3.1 - [@prisma/internals](https://npm.io/package/@prisma/internals.md) ^4.3.1 - [@prisma/generator-helper](https://npm.io/package/@prisma/generator-helper.md) ^4.3.1 ## Alternatives - [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads - [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads - [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads - [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads - [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads ## Recent versions - 0.7.1 (latest) — 2022-12-10 - 0.7.0 — 2022-12-08 - 0.6.1 — 2022-11-09 ## README # Prisma Zod Generator [![npm version](https://badge.fury.io/js/prisma-zod-generator.svg)](https://badge.fury.io/js/prisma-zod-generator) [![npm](https://img.shields.io/npm/dt/prisma-zod-generator.svg)](https://www.npmjs.com/package/prisma-zod-generator) [![HitCount](https://hits.dwyl.com/omar-dulaimi/prisma-zod-generator.svg?style=flat)](http://hits.dwyl.com/omar-dulaimi/prisma-zod-generator) [![npm](https://img.shields.io/npm/l/prisma-zod-generator.svg)](LICENSE) Automatically generate [Zod](https://github.com/colinhacks/zod) schemas from your [Prisma](https://github.com/prisma/prisma) Schema, and use them to validate your API endpoints or any other use you have. Updates every time `npx prisma generate` runs.

Buy Me A Coffee

## Table of Contents - [Supported Prisma Versions](#supported-prisma-versions) - [Installation](#installing) - [Usage](#usage) - [Customizations](#customizations) - [Additional Options](#additional-options) # Supported Prisma Versions ### Prisma 4 - 0.3.0 and higher ### Prisma 2/3 - 0.2.0 and lower # Installation Using npm: ```bash npm install prisma-zod-generator ``` Using yarn: ```bash yarn add prisma-zod-generator ``` # Usage 1- Star this repo 😉 2- Add the generator to your Prisma schema ```prisma generator zod { provider = "prisma-zod-generator" } ``` 3- Enable strict mode in `tsconfig` as it is required by Zod, and considered a Typescript best practice ```ts { "compilerOptions": { "strict": true } } ``` 4- Running `npx prisma generate` for the following schema.prisma ```prisma model User { id Int @id @default(autoincrement()) email String @unique name String? posts Post[] } model Post { id Int @id @default(autoincrement()) createdAt DateTime @default(now()) updatedAt DateTime @updatedAt title String content String? published Boolean @default(false) viewCount Int @default(0) author User? @relation(fields: [authorId], references: [id]) authorId Int? likes BigInt } ``` will generate the following files ![Zod Schemas](https://raw.githubusercontent.com/omar-dulaimi/prisma-zod-generator/master/zodSchemas.png) 5- Use generated schemas somewhere in your API logic, like middleware or decorator ```ts import { PostCreateOneSchema } from './prisma/generated/schemas/createOnePost.schema'; app.post('/blog', async (req, res, next) => { const { body } = req; await PostCreateOneSchema.parse(body); }); ``` # Customizations ## Skipping entire models ```prisma /// @@Gen.model(hide: true) model User { id Int @id @default(autoincrement()) email String @unique name String? } ``` # Additional Options | Option | Description | Type | Default | | ------------------- | -------------------------------------------------------------------------- | --------- | ------------- | | `output` | Output directory for the generated zod schemas | `string` | `./generated` | | `isGenerateSelect` | Enables the generation of Select related schemas and the select property | `boolean` | `false` | | `isGenerateInclude` | Enables the generation of Include related schemas and the include property | `boolean` | `false` | Use additional options in the `schema.prisma` ```prisma generator zod { provider = "prisma-zod-generator" output = "./generated-zod-schemas" isGenerateSelect = true isGenerateInclude = true } ``` --- _Source: https://npm.io/package/prism-prisma-zod-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._