prismadocify

生成Prisma模式的文档。

Prismadocify

prismadocify是一种命令行工具，可生成Prisma Schemas的Markdown文档。它读取您的Prisma架构文件，解析模型和枚举，并输出记录模式的Markdown文件。

hacktoberfest 2024 ??

该项目正在参加Hacktoberfest 2024！

我们欢迎开源社区的贡献，无论是错误修复，功能实现还是文档改进。每个贡献都针对您的Hacktoberfest目标。

如何贡献

1. 分叉此存储库并创建一个新的分支。
2. 找到要处理的问题，或通过打开问题提出新功能。
3. 在10月31日之前提交您的拉请求，以使其计入Hacktoberfest！

查看我们的贡献。md以获取详细指南。

---

特征

以下是prismadocify的一些关键特征：

• Markdown文档生成：自动为您的Prisma模式生成结构良好的标记文档。
• 对模型和枚举的支持：记录您的Prisma模型和枚举，并具有表格的输出。
• 可自定义路径（即将推出）：为架构输入和输出文档指定自定义路径。

安装

先决条件

• node.js（> = 16.x）
• 纱线或npm

通过NPM安装

npm install prismadocify

通过纱线安装

yarn add prismadocify

用法

安装prismadocify后，您可以从命令行使用它来为Prisma模式生成文档。

命令

prismadocify

默认情况下， prismadocify在./prisma/schema.prisma上查找Prisma架构文件，并在./prisma-docs.md中生成文档。

例子

这是一个简单的Prisma模式和生成的文档的示例：

Prisma模式（ schema.prisma ）

 model User {
  id         String   @id @default ( uuid () )
  email      String   @unique
  name       String ?
  createdAt  DateTime @default ( now () )
}

enum UserRole {
  ADMIN
  USER
}

生成的降价文档（ prisma-docs.md ）

 # Prisma Schema Documentation

## User

| Field     | Type     | List | Required | Unique |
| --------- | -------- | ---- | -------- | ------ |
| id        | String   | No   | Yes      | Yes    |
| email     | String   | No   | Yes      | Yes    |
| name      | String?  | No   | No       | No     |
| createdAt | DateTime | No   | Yes      | No     |

## Enums

### UserRole

ADMIN, USER

---

贡献

我们欢迎各种贡献！首先，请参阅有关如何为该项目做出贡献的指南的贡献。

执照

该项目已根据MIT许可获得许可。

致谢

感谢Prisma团队为此工具提供了很棒的ORM和灵感。