\n \n\n\n\n\n## About The Project\n\nI got tired of having to manually create Zod schemas for my Prisma models and of updating them everytime I made schema changes.\nThis provides a way of automatically generating them with your prisma\n\n\n\n### Built With\n\n- [dts-cli](https://github.com/weiran-zsd/dts-cli)\n- [Zod](https://github.com/colinhacks/zod)\n- [Based on this gist](https://gist.github.com/deckchairlabs/8a11c33311c01273deec7e739417dbc9)\n\n\n\n## Getting Started\n\nTo get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\nThis project utilizes yarn and if you plan on contributing, you should too.\n\n```sh\nnpm install -g yarn\n```\n\n### Installation\n\n0. **Ensure your tsconfig.json enables the compiler's strict mode.**\n **Zod requires it and so do we, you will experience TS errors without strict mode enabled**\n\n1. Add zod-prisma as a dev dependency\n\n ```sh\n yarn add -D zod-prisma\n ```\n\n2. Add the zod-prisma generator to your schema.prisma\n\n ```prisma\n generator zod {\n provider = \"zod-prisma\"\n output = \"./zod\" // (default) the directory where generated zod schemas will be saved\n\n relationModel = true // (default) Create and export both plain and related models.\n // relationModel = \"default\" // Do not export model without relations.\n // relationModel = false // Do not generate related model\n\n modelCase = \"PascalCase\" // (default) Output models using pascal case (ex. UserModel, PostModel)\n // modelCase = \"camelCase\" // Output models using camel case (ex. userModel, postModel)\n\n modelSuffix = \"Model\" // (default) Suffix to apply to your prisma models when naming Zod schemas\n\n // useDecimalJs = false // (default) represent the prisma Decimal type using as a JS number\n useDecimalJs = true // represent the prisma Decimal type using Decimal.js (as Prisma does)\n\n imports = null // (default) will import the referenced file in generated schemas to be used via imports.someExportedVariable\n\n // https://www.prisma.io/docs/concepts/components/prisma-client/working-with-fields/working-with-json-fields#filtering-by-null-values\n prismaJsonNullability = true // (default) uses prisma's scheme for JSON field nullability\n // prismaJsonNullability = false // allows null assignment to optional JSON fields\n }\n ```\n\n3. Run `npx prisma generate` or `yarn prisma generate` to generate your zod schemas\n4. Import the generated schemas form your selected output location\n\n\n\n## Usage\n\n### JSDoc Generation\n\n[Rich-comments](https://www.prisma.io/docs/concepts/components/prisma-schema#comments)\nin the Prisma schema will be transformed into JSDoc for the associated fields:\n\n> _Note: make sure to use a triple-slash. Double-slash comments won't be processed._\n\n```prisma\nmodel Post {\n /// The unique identifier for the post\n /// @default {Generated by database}\n id String @id @default(uuid())\n\n /// A brief title that describes the contents of the post\n title String\n\n /// The actual contents of the post.\n contents String\n}\n```\n\nGenerated code:\n\n```ts\nexport const PostModel = z.object({\n\t/**\n\t * The unique identifier for the post\n\t * @default {Generated by database}\n\t */\n\tid: z.string().uuid(),\n\t/**\n\t * A brief title that describes the contents of the post\n\t */\n\ttitle: z.string(),\n\t/**\n\t * The actual contents of the post.\n\t */\n\tcontents: z.string(),\n})\n```\n\n### Extending Zod Fields\n\nYou can also use the `@zod` keyword in rich-comments in the Prisma schema\nto extend your Zod schema fields:\n\n```prisma\nmodel Post {\n id String @id @default(uuid()) /// @zod.uuid()\n\n /// @zod.max(255, { message: \"The title must be shorter than 256 characters\" })\n title String\n\n contents String /// @zod.max(10240)\n}\n```\n\nGenerated code:\n\n```ts\nexport const PostModel = z.object({\n\tid: z.string().uuid(),\n\ttitle: z.string().max(255, { message: 'The title must be shorter than 256 characters' }),\n\tcontents: z.string().max(10240),\n})\n```\n\n### Importing Helpers\n\nSometimes its useful to define a custom Zod preprocessor or transformer for your data.\nzod-prisma enables you to reuse these by importing them via a config options. For example:\n\n```prisma\ngenerator zod {\n provider = \"zod-prisma\"\n output = \"./zod\"\n imports \t\t = \"../src/zod-schemas\"\n}\n\nmodel User {\n username\tString /// @zod.refine(imports.isValidUsername)\n}\n```\n\nThe referenced file can then be used by simply referring to exported members via `imports.whateverExport`.\nThe generated zod schema files will now include a namespaced import like the following.\n\n```typescript\nimport * as imports from '../../src/zod-schemas'\n```\n\n#### Custom Zod Schema\n\nIn conjunction with this import option, you may want to utilize an entirely custom zod schema for a field.\nThis can be accomplished by using the special comment directive `@zod.custom()`.\nBy specifying the custom schema within the parentheses you can replace the autogenerated type that would normally be assigned to the field.\n\n> For instance if you wanted to use `z.preprocess`\n\n### JSON Fields\n\nJSON fields in Prisma disallow null values. This is to disambiguate between setting a field's value to NULL in the database and having\na value of null stored in the JSON. In accordance with this zod-prisma will default to disallowing null values, even if your JSON field is optional.\n\nIf you would like to revert this behavior and allow null assignment to JSON fields,\nyou can set `prismaJsonNullability` to `false` in the generator options.\n\n## Examples\n\n\n\n_For examples, please refer to the [Examples Directory](https://github.com/CarterGrimmeisen/zod-prisma/blob/main/examples) or the [Functional Tests](https://github.com/CarterGrimmeisen/zod-prisma/blob/main/src/test/functional)_\n\n\n\n## Roadmap\n\nSee the [open issues](https://github.com/CarterGrimmeisen/zod-prisma/issues) for a list of proposed features (and known issues).\n\n\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n\n## Contact\n\nCarter Grimmeisen - Carter.Grimmeisen@uah.edu\n\nProject Link: [https://github.com/CarterGrimmeisen/zod-prisma](https://github.com/CarterGrimmeisen/zod-prisma)\n\n\n\n\n[npm-shield]: https://img.shields.io/npm/v/zod-prisma?style=for-the-badge\n[npm-url]: https://www.npmjs.com/package/zod-prisma\n[contributors-shield]: https://img.shields.io/github/contributors/CarterGrimmeisen/zod-prisma.svg?style=for-the-badge\n[contributors-url]: https://github.com/CarterGrimmeisen/zod-prisma/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/CarterGrimmeisen/zod-prisma.svg?style=for-the-badge\n[forks-url]: https://github.com/CarterGrimmeisen/zod-prisma/network/members\n[stars-shield]: https://img.shields.io/github/stars/CarterGrimmeisen/zod-prisma.svg?style=for-the-badge\n[stars-url]: https://github.com/CarterGrimmeisen/zod-prisma/stargazers\n[issues-shield]: https://img.shields.io/github/issues/CarterGrimmeisen/zod-prisma.svg?style=for-the-badge\n[issues-url]: https://github.com/CarterGrimmeisen/zod-prisma/issues\n[license-shield]: https://img.shields.io/github/license/CarterGrimmeisen/zod-prisma.svg?style=for-the-badge\n[license-url]: https://github.com/CarterGrimmeisen/zod-prisma/blob/main/LICENSE\n","readmeFilename":"README.md"}
![\"Logo\"](\"https://raw.githubusercontent.com/CarterGrimmeisen/zod-prisma/main/images/zod-prisma.svg\")
\n \n