prismadocify

프리즘 스키마에 대한 문서를 생성합니다.

prismadocify

prismadocify 는 Prisma Schemas에 대한 Markdown 문서를 생성하는 명령 줄 도구입니다. 프리즘 스키마 파일을 읽고 모델과 열거를 구문 분석하고 스키마를 문서화하는 마크 다운 파일을 출력합니다.

Hacktoberfest 2024 ??

이 프로젝트는 Hacktoberfest 2024에 참여하고 있습니다!

버그 수정, 기능 구현 또는 문서 개선 등 오픈 소스 커뮤니티의 기여를 환영합니다. 모든 기여는 Hacktoberfest 목표에 중요합니다.

기여하는 방법

1. 이 저장소를 포크 하고 새 지점을 만듭니다.
2. 작업 할 문제를 찾 거나 문제를 열어 새로운 기능을 제안하십시오.
3. Hacktoberfest를 계산하기 위해 10 월 31 일 이전에 풀 요청을 제출하십시오 !

자세한 가이드 라인은 Contributing.md를 확인하십시오.

---

특징

prismadocify 의 주요 기능은 다음과 같습니다.

• Markdown 문서 생성 : Prisma Schemas에 대한 잘 구조화 된 Markdown 문서를 자동으로 생성합니다.
• 모델 및 열거 지원 : Prisma 모델 및 열거를 테이블 형식 출력으로 문서화하십시오.
• 사용자 정의 가능한 경로 (곧 출시) : 스키마 입력 및 출력 문서에 대한 사용자 정의 경로를 지정합니다.

설치

전제 조건

• node.js (> = 16.x)
• 원사 또는 NPM

NPM을 통해 설치하십시오

npm install prismadocify

원사를 통해 설치하십시오

yarn add prismadocify

용법

prismadocify 설치 한 후 명령 줄에서 사용하여 Prisma 스키마에 대한 문서를 생성 할 수 있습니다.

명령

prismadocify

기본적으로 prismadocify ./prisma/schema.prisma 의 Prisma 스키마 파일을 찾고 ./prisma-docs.md 에서 문서를 생성합니다.

예

다음은 간단한 프리즘 스키마와 생성 된 문서의 예입니다.

프리즘 스키마 ( schema.prisma )

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

enum UserRole {
  ADMIN
  USER
}

생성 된 마크 다운 문서 ( 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

---

기여

우리는 모든 종류의 기여를 환영합니다! 시작하려면 Project에 기여하는 방법에 대한 지침은 Contributing.md를 참조하십시오.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다.

감사의 말

이 도구에 대한 멋진 ORM과 영감을 주신 Prisma 팀에게 감사드립니다.