prismadocify

Genere documentación para los esquemas de Prisma.

Prismadocificar

prismadocify es una herramienta de línea de comandos que genera documentación de Markdown para los esquemas de Prisma. Lee su archivo de esquema de Prisma, analiza los modelos y enumeros, y genera un archivo de Markdown que documenta el esquema.

Hacktoberfest 2024 ??

¡Este proyecto participa en Hacktoberfest 2024!

Agradecemos las contribuciones de la comunidad de código abierto, ya sean correcciones de errores, implementaciones de características o mejoras de documentación. Cada contribución cuenta para su objetivo de Hacktoberfest.

Cómo contribuir

1. Bifurca este repositorio y crea una nueva rama.
2. Encuentre un problema para trabajar o proponer una nueva característica abriendo un problema.
3. ¡Envíe su solicitud de extracción antes del 31 de octubre para que cuente para Hacktoberfest!

Consulte nuestro contribuyente. MD para obtener pautas detalladas.

---

Características

Estas son algunas de las características clave de prismadocify :

• Generación de documentación de Markdown : genera automáticamente la documentación de Markdown bien estructurada para sus esquemas PRISMA.
• Soporte para modelos y enums : documente sus modelos prisma y enumeros con salida de mesa.
• Rutas personalizables (próximamente): especifique rutas personalizadas para la documentación de entrada y salida de esquema.

Instalación

Requisitos previos

• Node.js (> = 16.x)
• Hilo o npm

Instalar a través de NPM

npm install prismadocify

Instalar a través del hilo

yarn add prismadocify

Uso

Después de instalar prismadocify , puede usarlo desde la línea de comando para generar documentación para su esquema PRISMA.

Dominio

prismadocify

Por defecto, prismadocify busca el archivo de esquema de Prisma en ./prisma/schema.prisma y genera la documentación en ./prisma-docs.md .

Ejemplo

Aquí hay un ejemplo de un simple esquema de Prisma y la documentación generada:

Esquema de prisma ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

Documentación de Markdown generada ( 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

---

Que contribuye

¡Agradecemos las contribuciones de todo tipo! Para comenzar, consulte The Contriping.MD para obtener pautas sobre cómo contribuir al proyecto.

Licencia

Este proyecto tiene licencia bajo la licencia MIT.

Expresiones de gratitud

Gracias al equipo de Prisma por su increíble ORM e inspiración para esta herramienta.