prismadocify

Générez la documentation pour les schémas PRISMA.

Primadocifier

prismadocify est un outil de ligne de commande qui génère une documentation Markdown pour les schémas PRISMA. Il lit votre fichier de schéma PRISMA, analyse les modèles et les énumérations, et publie un fichier Markdown documentant le schéma.

Hacktoberfest 2024 ??

Ce projet participe au Hacktoberfest 2024!

Nous accueillons les contributions de la communauté open source, qu'il s'agisse de corrections de bogues, d'implémentations de fonctionnalités ou d'améliorations de documentation. Chaque contribution compte pour votre objectif Hacktoberfest.

Comment contribuer

1. Fourk ce référentiel et créez une nouvelle branche.
2. Trouvez un problème sur lequel travailler ou proposer une nouvelle fonctionnalité en ouvrant un problème.
3. Soumettez votre demande de traction avant le 31 octobre pour que cela compte pour Hacktoberfest!

Consultez notre contribution.md pour des directives détaillées.

---

Caractéristiques

Voici quelques-unes des principales caractéristiques de prismadocify :

• Génération de la documentation de Markdown : génère automatiquement la documentation de marque bien structurée pour vos schémas PRISMA.
• Prise en charge des modèles et des énumérations : documentez vos modèles et énumérations PRISMA avec une sortie formée par la table.
• Chemins personnalisables (à venir bientôt): spécifiez des chemins personnalisés pour la documentation d'entrée et de sortie du schéma.

Installation

Condition préalable

• Node.js (> = 16.x)
• Fil ou NPM

Installer via NPM

npm install prismadocify

Installer via le fil

yarn add prismadocify

Usage

Après avoir installé prismadocify , vous pouvez l'utiliser à partir de la ligne de commande pour générer une documentation pour votre schéma PRISMA.

Commande

prismadocify

Par défaut, prismadocify recherche le fichier de schéma PRISMA à ./prisma/schema.prisma et génère la documentation dans ./prisma-docs.md .

Exemple

Voici un exemple d'un schéma de prisma simple et de la documentation générée:

Prisma Schema ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

Documentation générée de Markdown ( 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

---

Contributif

Nous accueillons les contributions de toutes sortes! Pour commencer, veuillez consulter le contribution.md pour des directives sur la façon de contribuer au projet.

Licence

Ce projet est autorisé sous la licence du MIT.

Remerciements

Merci à l'équipe PRISMA pour son ORM et inspiration impressionnants pour cet outil.