prismadocify

สร้างเอกสารสำหรับ Prisma schemas

Prismadocify

prismadocify เป็นเครื่องมือบรรทัดคำสั่งที่สร้างเอกสารมาร์เดอร์สำหรับ SCHEMA PRISMA มันอ่านไฟล์ Schema Prisma ของคุณวิเคราะห์โมเดลและ enums และส่งออกไฟล์ markdown ที่บันทึกสคีมา

Hacktoberfest 2024 ??

โครงการนี้มีส่วนร่วมใน Hacktoberfest 2024!

เรายินดีต้อนรับการมีส่วนร่วมจากชุมชนโอเพ่นซอร์สไม่ว่าจะเป็นการแก้ไขข้อผิดพลาดการใช้งานคุณสมบัติหรือการปรับปรุงเอกสาร การบริจาคทุกครั้งจะนับรวมถึงเป้าหมาย Hacktoberfest ของคุณ

วิธีการมีส่วนร่วม

1. แยกที่เก็บนี้ และสร้างสาขาใหม่
2. ค้นหาปัญหา ในการทำงานหรือเสนอคุณสมบัติใหม่โดยการเปิดปัญหา
3. ส่งคำขอดึงของคุณ ก่อนวันที่ 31 ตุลาคมเพื่อให้นับสำหรับ Hacktoberfest!

ตรวจสอบการสนับสนุนของเรา MD สำหรับแนวทางโดยละเอียด

---

คุณสมบัติ

นี่คือคุณสมบัติสำคัญบางประการของ prismadocify :

• การสร้างเอกสาร Markdown : สร้างเอกสารมาร์เดอร์ที่มีโครงสร้างที่ดีโดยอัตโนมัติสำหรับ Schemas PRISMA ของคุณ
• รองรับโมเดลและ enums : จัดทำเอกสารโมเดล PRISMA ของคุณและ enums ด้วยเอาต์พุตแบบจัดรูปแบบตาราง
• เส้นทางที่ปรับแต่งได้ (เร็ว ๆ นี้): ระบุเส้นทางที่กำหนดเองสำหรับเอกสารอินพุตสคีมาและเอกสารเอาท์พุท

การติดตั้ง

ข้อกำหนดเบื้องต้น

• node.js (> = 16.x)
• เส้นด้ายหรือ NPM

ติดตั้งผ่าน NPM

npm install prismadocify

ติดตั้งผ่านเส้นด้าย

yarn add prismadocify

การใช้งาน

หลังจากติดตั้ง prismadocify คุณสามารถใช้จากบรรทัดคำสั่งเพื่อสร้างเอกสารสำหรับ Schema Prisma ของคุณ

สั่งการ

prismadocify

โดยค่าเริ่มต้น prismadocify มองหาไฟล์ Schema Prisma ที่ ./prisma/schema.prisma และสร้างเอกสารใน ./prisma-docs.md

ตัวอย่าง

นี่คือตัวอย่างของสคีมา Prisma อย่างง่ายและเอกสารที่สร้างขึ้น:

Prisma Schema ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

เอกสาร 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

---

การบริจาค

เรายินดีต้อนรับการมีส่วนร่วมทุกชนิด! ในการเริ่มต้นโปรดดูที่ MD สำหรับแนวทางเกี่ยวกับวิธีการมีส่วนร่วมในโครงการ

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT

กิตติกรรมประกาศ

ขอบคุณทีม Prisma สำหรับ ORM ที่ยอดเยี่ยมและแรงบันดาลใจสำหรับเครื่องมือนี้