Prisma ERD Generator 项目常见问题解决方案

Prisma ERD Generator 项目常见问题解决方案

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

项目基础介绍

Prisma ERD Generator 是一个开源项目，旨在帮助开发者基于 Prisma 数据模型生成实体关系图（ER Diagram）。每次运行 npx prisma generate 命令时，该项目会自动生成相应的 ER 图。该项目的主要编程语言是 JavaScript，依赖于 Node.js 环境。

新手使用注意事项及解决方案

1. 安装依赖时遇到版本不兼容问题

问题描述：
新手在安装 prisma-erd-generator 时，可能会遇到依赖包版本不兼容的问题，导致安装失败。

解决步骤：

1. 检查 Prisma 版本：
   确保你的 Prisma 版本与 prisma-erd-generator 兼容。根据项目文档，Prisma 4.x 及以上版本应使用 prisma-erd-generator 的 1.x 版本，而 Prisma 4.x 以下版本应使用 0.11.x 版本。

2. 更新或降级 Prisma：
   如果 Prisma 版本不兼容，可以通过以下命令更新或降级 Prisma：

   npm install prisma@<version>
   

   或

   yarn add prisma@<version>
   

3. 安装 prisma-erd-generator：
   确保安装了正确版本的 prisma-erd-generator：

   npm install -D prisma-erd-generator @mermaid-js/mermaid-cli
   

   或

   yarn add -D prisma-erd-generator @mermaid-js/mermaid-cli
   

2. 生成 ER 图时找不到 mmdc 二进制文件

问题描述：
在生成 ER 图时，可能会遇到找不到 mmdc（Mermaid CLI）二进制文件的错误。

解决步骤：

1. 检查 mmdc 是否安装：
   确保 @mermaid-js/mermaid-cli 已正确安装。如果没有安装，可以通过以下命令安装：

   npm install -D @mermaid-js/mermaid-cli
   

   或

   yarn add -D @mermaid-js/mermaid-cli
   

2. 指定 mmdc 路径：
   如果 mmdc 安装在非默认路径，可以在 prisma 配置中指定 mmdc 的路径：

   generator erd {
     provider = "prisma-erd-generator"
     mmdcPath = "node_modules/.bin/mmdc"
   }
   

3. 重新生成 Prisma 客户端：
   运行以下命令重新生成 Prisma 客户端和 ER 图：

   npx prisma generate
   

3. 生成的 ER 图格式或主题不符合预期

问题描述：
生成的 ER 图格式（如 SVG、PNG 等）或主题（如 forest、dark 等）不符合预期。

解决步骤：

1. 检查输出格式和主题配置：
   确保在 prisma 配置中正确设置了输出格式和主题：

   generator erd {
     provider = "prisma-erd-generator"
     output = "./prisma/ERD.svg"
     theme = "forest"
   }
   

2. 修改配置：
   如果需要更改输出格式或主题，可以直接修改 prisma 配置文件中的 output 和 theme 选项。

3. 重新生成 ER 图：
   运行以下命令重新生成 ER 图：

   npx prisma generate
   

通过以上步骤，新手可以顺利解决在使用 Prisma ERD Generator 项目时遇到的常见问题。

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