prismadocify

Prismaスキーマのドキュメントを生成します。

prismadocify

prismadocify 、PrismaスキーマのMarkdownドキュメントを生成するコマンドラインツールです。 Prismaスキーマファイルを読み取り、モデルと酵素を解析し、スキーマを文書化するマークダウンファイルを出力します。

ハックトーバーフェスト2024 ??

このプロジェクトは、Hacktoberfest 2024に参加しています！

バグの修正、機能の実装、ドキュメントの改善など、オープンソースコミュニティからの貢献を歓迎します。すべての貢献は、ハックトーバーフェストの目標にカウントされます。

貢献する方法

1. このリポジトリをフォークし、新しいブランチを作成します。
2. 取り組む問題を見つけたり、問題を開いて新機能を提案したりします。
3. 10月31日までにプルリクエストを送信して、Hacktoberfestにカウントしてください！

詳細なガイドラインについては、contributing.mdをご覧ください。

---

特徴

prismadocifyの重要な機能の一部は次のとおりです。

• Markdown Documentation Generation ：Prismaスキーマの適切に構造化されたMarkdownドキュメントを自動的に生成します。
• モデルと列挙のサポート：テーブルフォーマット出力でPRISMAモデルと酵素を文書化します。
• カスタマイズ可能なパス（近日公開）：スキーマ入力および出力ドキュメントのカスタムパスを指定します。

インストール

前提条件

• node.js（> = 16.x）
• 糸またはnpm

NPM経由でインストールします

npm install prismadocify

Yarn経由でインストールします

yarn add prismadocify

使用法

prismadocifyをインストールした後、コマンドラインから使用して、Prismaスキーマのドキュメントを生成できます。

指示

prismadocify

デフォルトでは、 prismadocify ./prisma/schema.prismaのPrismaスキーマファイルを探し、 ./prisma-docs.mdでドキュメントを生成します。

例

以下は、単純なプリスマスキーマと生成されたドキュメントの例です。

プリスマスキーマ（ 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

---

貢献

あらゆる種類の貢献を歓迎します！開始するには、プロジェクトへの貢献方法に関するガイドラインについては、Contributing.mdをご覧ください。

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。

謝辞

このツールの素晴らしいORMとインスピレーションをしてくれたPrismaチームに感謝します。