Prisma Case Format 安装与配置指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01025/article/details/147324839

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.prisma 文件中的命名规范统一化。它可以将模型名（table）、字段名（field）和枚举名（enum）转换为 PascalCase、camelCase 或 snake_case 等命名规范。此外，它还支持对映射（map）进行命名规范转换，并且可以选择性地为模型和字段设置复数或单数形式。

主要编程语言：JavaScript

2. 项目使用的关键技术和框架

Node.js：项目运行的基础环境。
Prisma：用于数据库操作的工具，本项目主要针对 Prisma 生成的 schema.prisma 文件进行操作。
Yarn：JavaScript 的包管理工具，用于管理项目依赖。

3. 项目安装和配置的准备工作及详细安装步骤

准备工作

确保您的系统上已安装 Node.js，可以通过在命令行中运行 node -v 来检查是否安装以及安装的版本。
安装 Yarn，如果您的系统中尚未安装。可以通过在命令行中运行 npm install -g yarn 来安装。

安装步骤

克隆项目到本地

打开命令行，切换到您希望存储项目的目录，然后执行以下命令克隆项目：
```
git clone https://github.com/iiian/prisma-case-format.git
```
安装依赖

切换到项目目录中，然后执行以下命令安装项目依赖：
```
cd prisma-case-format
yarn install
```
配置项目

根据您的需求，在项目根目录下创建或编辑 .prisma-case-format 文件。该文件允许您设置默认的命名规范，以及为特定的模型和字段设置命名规范。

例如，以下是一个简单的配置文件示例：
```
default: 'table=pascal; field=camel; enum=pascal'
```
运行项目

运行以下命令来应用命名规范转换：
```
yarn run prisma-case-format
```
如果您想要查看将要发生的改变而不直接应用到文件，可以添加 --dry-run 参数：
```
yarn run prisma-case-format --dry-run
```
查看文档

为了更好地了解项目的所有配置选项和使用方法，可以查阅项目自带的文档。