Prisma ERD Generator 使用教程

Prisma ERD Generator 使用教程

prisma-erd-generatorGenerate an ER Diagram based on your Prisma schema every time you run npx prisma generate项目地址:https://gitcode.com/gh_mirrors/pr/prisma-erd-generator

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

prisma-erd-generator/
├── src/
│   ├── index.ts
│   ├── generator.ts
│   ├── utils.ts
│   └── types.ts
├── package.json
├── tsconfig.json
└── README.md

• src/: 包含项目的主要源代码文件。
  • index.ts: 项目的入口文件。
  • generator.ts: 生成ERD图的主要逻辑。
  • utils.ts: 包含一些辅助函数。
  • types.ts: 定义项目中使用的类型。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

src/index.ts 是项目的入口文件，负责初始化和调用生成器逻辑。以下是简要代码示例：

import { generate } from './generator';

async function main() {
  await generate();
}

main().catch(console.error);

• generate 函数位于 generator.ts 文件中，负责生成ERD图。
• main 函数是程序的入口点，捕获并处理可能的错误。

3. 项目的配置文件介绍

package.json

{
  "name": "prisma-erd-generator",
  "version": "1.0.0",
  "description": "Generate Entity Relationship Diagrams (ERD) for your Prisma schema.",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "start": "node dist/index.js"
  },
  "dependencies": {
    "@prisma/client": "^3.0.0",
    "graphql": "^15.5.0"
  },
  "devDependencies": {
    "typescript": "^4.3.5"
  }
}

• name, version, description: 项目的基本信息。
• main: 指定编译后的入口文件。
• scripts: 定义了一些常用的脚本命令，如 build 和 start。
• dependencies 和 devDependencies: 项目的依赖包。

tsconfig.json

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

• compilerOptions: TypeScript 编译选项。
  • target: 指定编译目标为 ES6。
  • module: 使用 commonjs 模块系统。
  • outDir: 编译输出目录。
  • strict: 启用严格模式。
  • esModuleInterop: 启用 ES 模块互操作。
• include: 指定包含的源代码目录。

prisma-erd-generatorGenerate an ER Diagram based on your Prisma schema every time you run npx prisma generate项目地址:https://gitcode.com/gh_mirrors/pr/prisma-erd-generator