Prisma Zod Generator 项目教程

Prisma Zod Generator 项目教程

prisma-zod-generator Prisma 2+ generator to emit Zod schemas from your Prisma schema 项目地址: https://gitcode.com/gh_mirrors/pr/prisma-zod-generator

1. 项目的目录结构及介绍

prisma-zod-generator/
├── src/
│   ├── generators/
│   │   ├── PrismaZodGenerator.ts
│   │   └── index.ts
│   ├── utils/
│   │   └── index.ts
│   ├── index.ts
│   └── cli.ts
├── prisma/
│   ├── schema.prisma
│   └── migrations/
├── package.json
├── tsconfig.json
└── README.md

• src/: 项目的主要源代码目录。
  • generators/: 包含生成器的主要逻辑，PrismaZodGenerator.ts 是核心文件，index.ts 是入口文件。
  • utils/: 包含一些工具函数。
  • index.ts: 项目的入口文件。
  • cli.ts: 命令行接口文件。
• prisma/: Prisma 相关的配置和迁移文件。
  • schema.prisma: Prisma 的数据库模式文件。
  • migrations/: 包含数据库迁移文件。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。这个文件是整个项目的入口点，负责初始化生成器并启动项目。

import { PrismaZodGenerator } from './generators/PrismaZodGenerator';

// 初始化生成器
const generator = new PrismaZodGenerator();

// 启动生成器
generator.generate();

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "prisma-zod-generator",
  "version": "1.0.0",
  "description": "Prisma Zod Generator",
  "main": "src/index.ts",
  "scripts": {
    "start": "ts-node src/index.ts",
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "prisma": "^3.0.0",
    "zod": "^3.0.0"
  },
  "devDependencies": {
    "ts-node": "^10.0.0",
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

prisma-zod-generator Prisma 2+ generator to emit Zod schemas from your Prisma schema 项目地址: https://gitcode.com/gh_mirrors/pr/prisma-zod-generator