prismadocify

Gere documentação para esquemas de prisma.

Prismadocify

prismadocify é uma ferramenta de linha de comando que gera documentação de marcação para esquemas de prisma. Ele lê seu arquivo de esquema PRISMA, analisa os modelos e enumes e produz um arquivo de marcação documentando o esquema.

Hacktoberfest 2024 ??

Este projeto está participando da Hacktoberfest 2024!

Congratulamo-nos com contribuições da comunidade de código aberto, sejam correções de bugs, implementações de recursos ou melhorias de documentação. Toda contribuição conta para o seu objetivo Hacktoberfest.

Como contribuir

1. Fifra este repositório e crie uma nova filial.
2. Encontre um problema para trabalhar ou propor um novo recurso abrindo um problema.
3. Envie sua solicitação de tração antes de 31 de outubro para fazê -lo contar para a Hacktoberfest!

Confira nosso contribuinte.md para obter diretrizes detalhadas.

---

Características

Aqui estão algumas das principais características do prismadocify :

• Documentação de marcação Geração : gera automaticamente documentação de marcação bem estruturada para seus esquemas PRISMA.
• Suporte para modelos e enumes : documente seus modelos e enumes prisma com saída formatada por tabela.
• Caminhos personalizáveis ​​(em breve): Especifique caminhos personalizados para a documentação de entrada e saída de esquema.

Instalação

Pré -requisitos

• Node.js (> = 16.x)
• Fio ou npm

Instale via npm

npm install prismadocify

Instale via YARN

yarn add prismadocify

Uso

Depois de instalar prismadocify , você pode usá -lo na linha de comando para gerar documentação para o seu esquema PRISMA.

Comando

prismadocify

Por padrão, prismadocify procura o arquivo de esquema prisma em ./prisma/schema.prisma e gera a documentação em ./prisma-docs.md .

Exemplo

Aqui está um exemplo de um esquema PRISMA simples e a documentação gerada:

Esquema prisma ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

Documentação de remarca gerada ( 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

---

Contribuindo

Congratulamo -nos com contribuições de todos os tipos! Para começar, consulte o contribuindo.md para obter diretrizes sobre como contribuir para o projeto.

Licença

Este projeto está licenciado sob a licença do MIT.

Agradecimentos

Agradecemos à equipe do Prisma por sua incrível ORM e inspiração para esta ferramenta.