prismadocify

Generieren Sie Dokumentation für Prisma -Schemata.

Prismadocify

prismadocify ist ein Befehlszeilen-Tool, das Markdown-Dokumentation für Prisma-Schemata generiert. Es liest Ihre Prisma -Schema -Datei, analysiert die Modelle und Aufzüge und gibt eine Markdown -Datei aus, die das Schema dokumentiert.

HacktoBerfest 2024 ??

Dieses Projekt nimmt am Hacktoberfest 2024 teil!

Wir begrüßen Beiträge der Open-Source-Community, unabhängig davon, ob es sich um Fehlerbehebungen, Feature-Implementierungen oder Dokumentationsverbesserungen handelt. Jeder Beitrag zählt zu Ihrem Hacktoberfest -Ziel.

Wie man beiträgt

1. Geben Sie dieses Repository auf und erstellen Sie eine neue Filiale.
2. Finden Sie ein Problem, an dem Sie arbeiten können, oder schlagen Sie eine neue Funktion vor, indem Sie ein Problem eröffnen.
3. Senden Sie Ihre Pull -Anfrage vor dem 31. Oktober, um es für das HacktoBerfest zu zählen!

Weitere Informationen finden Sie in unserem Beitrag in unserem Beitrag.

---

Merkmale

Hier sind einige der wichtigsten Merkmale von prismadocify :

• Markdown-Dokumentationsgenerierung : Erzeugt automatisch eine gut strukturierte Markdown-Dokumentation für Ihre Prisma-Schemata.
• Unterstützung für Modelle und Aufzüge : Dokumentieren Sie Ihre Prisma-Modelle und -Enums mit tischformatiertem Ausgang.
• Anpassbare Pfade (in Kürze): Geben Sie benutzerdefinierte Pfade für die Schemaeingabe- und Ausgangsdokumentation an.

Installation

Voraussetzungen

• Node.js (> = 16.x)
• Garn oder NPM

Installieren Sie über NPM

npm install prismadocify

Über Garn einbauen

yarn add prismadocify

Verwendung

Nach dem Installieren von prismadocify können Sie es aus der Befehlszeile verwenden, um Dokumentation für Ihr Prisma -Schema zu generieren.

Befehl

prismadocify

Standardmäßig sucht prismadocify nach der Prisma-Schema-Datei unter ./prisma/schema.prisma und generiert die Dokumentation in ./prisma-docs.md .

Beispiel

Hier ist ein Beispiel für ein einfaches Prisma -Schema und die generierte Dokumentation:

Prisma -Schema ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

Generierte Markdown-Dokumentation ( 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

---

Beitragen

Wir begrüßen Beiträge aller Art! Um loszulegen, finden Sie im beitragen.md für Richtlinien, wie Sie zum Projekt beitragen können.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.

Anerkennung

Vielen Dank an das Prisma -Team für ihre großartige Orm und Inspiration für dieses Tool.