kndev-erd-generator

Генератор ER-диаграмм из моделей в формате .zmodel (Zenstack) с поддержкой абстрактных моделей, наследования и реляционных связей.
Выводит универсальный JSON или диаграмму в формате Mermaid для удобного отображения в Angular и других приложениях.

Возможности

• Поддержка абстрактных моделей (abstract model)
• Поддержка наследования (extends)
• Поддержка реляционных связей с использованием аннотаций @relation
• Генерация JSON для дальнейшей обработки или Mermaid-диаграммы
• Конфигурируемый путь к исходным моделям и выходному файлу
• Легко интегрируется с Angular-компонентом для визуализации

Установка

npm install kndev-erd-generator

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

CLI

kndev-erd-generator --schemaDir ./path/to/zmodel --output ./output/erd.json --driver mermaid

Параметры:

• --schemaDir — директория с .zmodel файлами (по умолчанию ./schema)
• --outputFile — путь к выходному файлу с результатом (по умолчанию ./erd.json)
• --driver — формат вывода: default (универсальный JSON) или mermaid (Mermaid диаграмма) (по умолчанию default)

Пример конфигурации в package.json

{
  "kndevErdGenerator": {
    "schemaDir": "./schema",
    "outputFile": "./erd.json",
    "driver": "mermaid"
  },
  "scripts": {
    "generate-erd": "kndev-erd-generator"
  }
}

Теперь можно запускать генератор через:

npm run generate-erd

Пример .zmodel

abstract model Party {
  id   String @id @default(uuid())
  name String
}

model Person extends Party {
  email  String  @unique
  orders Order[] @relation(fields: [id], references: [customerId])
}

model Order {
  id         String   @id @default(uuid())
  orderDate  DateTime
  customerId String
  customer   Person   @relation(fields: [customerId], references: [id])
}

Интеграция с Angular

Используйте сгенерированный файл JSON и компонент Angular для отображения Mermaid диаграммы.
Подробную инструкцию смотрите в MERMAID.md.

Лицензия

MIT