Prisma Case Format 使用教程

Prisma Case Format 使用教程

1. 项目介绍

Prisma Case Format 是一个开源工具，旨在帮助开发者规范 Prisma 的 schema.prisma 文件中的命名约定。它可以将数据库模型、字段和枚举的命名转换为 PascalCase、camelCase 或 snake_case 等格式，同时支持对 @map 注解的命名转换，确保生成的 Prisma 客户端库的命名与你的数据库命名约定保持一致。

2. 项目快速启动

首先，确保你的系统中已经安装了 Node.js。然后按照以下步骤快速启动：

# 克隆项目
git clone https://github.com/iiian/prisma-case-format.git

# 进入项目目录
cd prisma-case-format

# 安装依赖
npm install

# 运行示例
npx prisma-case-format

上面的命令会读取当前目录下的 schema.prisma 文件，并根据默认的命名约定进行转换。

如果你需要指定文件或配置文件，可以使用以下命令：

# 指定 schema.prisma 文件
npx prisma-case-format --file path/to/your/schema.prisma

# 指定配置文件
npx prisma-case-format --config-file path/to/your/prisma-case-format.config.js

3. 应用案例和最佳实践

案例一：迁移命名约定

如果你的数据库已经有了一个庞大的 schema，并且命名约定不统一，你可以使用 Prisma Case Format 进行一次性的迁移。

# 使用 dry-run 参数预览变更
npx prisma-case-format --dry-run --table-case pascal --field-case camel

# 确认变更无误后，去掉 dry-run 参数应用变更
npx prisma-case-format --table-case pascal --field-case camel

案例二：保护特定模型

如果你的项目中使用了 NextAuth.js，你可能希望保护如 Account、User、Session 等模型的数据合同。可以使用 --uses-next-auth 参数。

# 保护 NextAuth.js 模型
npx prisma-case-format --uses-next-auth

最佳实践

• 在 CI/CD 流程中加入 Prisma Case Format，以确保 schema.prisma 文件的命名约定始终符合规范。
• 使用配置文件来定义特定的命名约定，以便在多个项目中重用。

4. 典型生态项目

Prisma Case Format 可以与 Prisma、NextAuth.js 以及其他数据库相关项目配合使用，形成完整的开发生态。例如：

• Prisma: Prisma 是一个强大的数据库工具集，Prisma Case Format 可以帮助规范其 schema 文件。
• NextAuth.js: 用于身份验证的框架，Prisma Case Format 可以保护其数据模型不被命名约定变更影响。
• 各种数据库: 包括 PostgreSQL、MySQL、SQLite 等，Prisma Case Format 支持多种数据库的命名约定转换。

通过以上介绍，你可以开始使用 Prisma Case Format 来改善你的 Prisma schema 文件的命名约定，从而提高代码的可读性和一致性。