prismadocify

Menghasilkan dokumentasi untuk skema prisma.

Prismadocify

prismadocify adalah alat baris perintah yang menghasilkan dokumentasi penurunan harga untuk skema prisma. Ini membaca file skema prisma Anda, mem -parsing model dan enum, dan mengeluarkan file markdown yang mendokumentasikan skema.

Hacktoberfest 2024 ??

Proyek ini berpartisipasi dalam Hacktoberfest 2024!

Kami menyambut kontribusi dari komunitas open-source, apakah itu perbaikan bug, implementasi fitur, atau peningkatan dokumentasi. Setiap kontribusi diperhitungkan untuk tujuan hacktoberfest Anda.

Bagaimana berkontribusi

1. Garakan repositori ini dan buat cabang baru.
2. Temukan masalah untuk dikerjakan, atau mengusulkan fitur baru dengan membuka masalah.
3. Kirimkan permintaan tarik Anda sebelum 31 Oktober untuk membuatnya dihitung untuk Hacktoberfest!

Lihatlah Kontribusi kami. MD untuk Pedoman Detail.

---

Fitur

Berikut adalah beberapa fitur utama prismadocify :

• Generasi Dokumentasi Markdown : Secara otomatis menghasilkan dokumentasi penurunan harga yang terstruktur dengan baik untuk skema prisma Anda.
• Dukungan untuk model dan enum : Dokumentasikan model prisma dan enum Anda dengan output yang diformat tabel.
• Jalur yang dapat disesuaikan (segera hadir): Tentukan jalur khusus untuk input skema dan dokumentasi output.

Instalasi

Prasyarat

• Node.js (> = 16.x)
• Benang atau npm

Instal melalui NPM

npm install prismadocify

Instal melalui benang

yarn add prismadocify

Penggunaan

Setelah menginstal prismadocify , Anda dapat menggunakannya dari baris perintah untuk menghasilkan dokumentasi untuk skema prisma Anda.

Memerintah

prismadocify

Secara default, prismadocify mencari file skema prisma di ./prisma/schema.prisma dan menghasilkan dokumentasi dalam ./prisma-docs.md .

Contoh

Berikut adalah contoh skema prisma sederhana dan dokumentasi yang dihasilkan:

Skema Prisma ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

Dokumentasi Markdown yang Dihasilkan ( 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

---

Berkontribusi

Kami menyambut semua jenis kontribusi! Untuk memulai, silakan lihat kontribusi.MD untuk pedoman tentang cara berkontribusi pada proyek.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.

Ucapan Terima Kasih

Terima kasih kepada tim PRISMA untuk ORM dan inspirasi mereka yang luar biasa untuk alat ini.