Prisma Case Format 项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01176/article/details/147323818

Prisma Case Format 项目使用教程

prisma-case-format Give your introspected schema.prisma sane naming conventions 项目地址: https://gitcode.com/gh_mirrors/pr/prisma-case-format

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

Prisma Case Format 是一个用于格式化 Prisma schema 文件的工具，使得模型（model）、字段（field）和枚举（enum）的命名遵循一定的命名约定。项目的目录结构如下：

prisma-case-format/
├── .github/              # GitHub 相关配置文件
├── .vscode/             # VSCode 相关配置文件
├── src/                  # 源代码目录
├── test/                 # 测试代码目录
├── .gitignore            # Git 忽略文件
├── .npmignore            # npm 忽略文件
├── LICENSE              # 许可证文件
├── README.md            # 项目说明文件
├── jest.config.js       # Jest 配置文件
├── package.json         # 项目配置文件
├── tsconfig.json        # TypeScript 配置文件
└── yarn.lock            # yarn 锁定文件

src/：包含项目的主要逻辑代码。
test/：包含项目的单元测试代码。
.gitignore 和 .npmignore：定义了在版本控制中应该忽略的文件。
LICENSE：项目使用的许可证信息。
README.md：项目的说明文档。
jest.config.js：Jest 测试框架的配置文件。
package.json：Node.js 项目配置文件，定义了项目的依赖、脚本等。
tsconfig.json：TypeScript 编译器的配置文件。
yarn.lock：记录项目的依赖版本信息。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本进行的。以下是 package.json 文件中的一些关键脚本：

"scripts": {
  "start": "prisma-case-format",
  "test": "jest",
  "build": "tsc"
}

"start"：启动项目的脚本，调用 prisma-case-format 命令。
"test"：运行测试的脚本，使用 Jest 测试框架。
"build"：构建项目的脚本，使用 TypeScript 编译器。

用户可以通过以下命令启动项目：

npm start
# 或者
yarn start

3. 项目的配置文件介绍

Prisma Case Format 使用一个配置文件 .prisma-case-format 来定义命名约定和特定模型的覆盖规则。

配置文件的格式如下：

default: 'table=pascal; field=camel; enum=pascal'
uses_next_auth: false

override:
  'ModelName':
    default: 'snake'
    field:
      'FieldName': 'customCase'