prismadocify

Генерировать документацию для схемы Prisma.

Prismadocify

prismadocify -это инструмент командной строки, который генерирует документацию на маркировке для схемы Prisma. Он читает ваш файл схемы Prisma, анализирует модели и перечисления и выводит файл разметки, документирующий схему.

Hacktoberfest 2024 ??

Этот проект участвует в Hacktoberfest 2024!

Мы приветствуем вклад сообщества с открытым исходным кодом, будь то исправление ошибок, реализации функций или улучшения документации. Каждый вклад учитывается к вашей цели Hacktoberfest.

Как внести свой вклад

1. Вилка этого репозитория и создайте новую ветку.
2. Найдите проблему для работы или предложите новую функцию, открыв проблему.
3. Отправьте свой запрос на привлечение до 31 октября, чтобы подсчитать Hacktoberfest!

Ознакомьтесь с нашим Appling.md для получения подробных рекомендаций.

---

Функции

Вот некоторые из ключевых особенностей prismadocify :

• Генерация документации Marckdown : автоматически генерирует хорошо структурированную документацию Markdown для ваших схем Prisma.
• Поддержка моделей и перечисления : документируйте ваши модели Prisma и перечисляет с форматированным таблицей выводом.
• Настраиваемые пути (скоро): укажите пользовательские пути для ввода схемы и документации вывода.

Установка

Предварительные условия

• Node.js (> = 16.x)
• Пряжа или NPM

Установите через NPM

npm install prismadocify

Установите через пряжу

yarn add prismadocify

Использование

После установки prismadocify вы можете использовать его из командной строки для создания документации для вашей схемы Prisma.

Командование

prismadocify

По умолчанию prismadocify ищет файл схемы 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
}

Сгенерированная документация на уценке ( 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

---

Внося

Мы приветствуем вклад всех видов! Чтобы начать, пожалуйста, посмотрите Appling.md для руководящих принципов о том, как внести свой вклад в проект.

Лицензия

Этот проект лицензирован по лицензии MIT.

Благодарности

Благодаря команде Prisma за их потрясающий ORM и вдохновение для этого инструмента.