table-builder

table-builder — це утиліта CLI для автоматизованого створення JSON-файлів таблиць, форм та карток на основі PostgreSQL бази даних. Вона генерує структуровані файли для використання у ваших проектах.

✨ Що нового у 2.0.0

• Перехід на TypeScript:
  • типізовані публічні інтерфейси та модулі;
  • згенеровані декларації типів (.d.ts) у пакеті;
  • оновлений процес збірки (компіляція TS → JS).
• Структура пакета: публікується скомпільований код (dist/) і типи, вихідні (src/) не входять у дистрибутив.
• Потенційні несумісності: якщо ви імпортували непублічні внутрішні шляхи, вони могли змінитися. Рекомендується імпортувати лише публічні точки входу.

Встановлення

Для встановлення пакета скористайтесь командою:

npm i @opengis/table-builder -D

Або використовуйте команду щоб встановити глобально:

npm i -g @opengis/table-builder

Використання

Синтаксис

Створити файли для однієї таблиці:

npx table-builder --module="<шлях до модулю>" --table="<назва таблиці>"

Створити файли для усіх таблиць у схемі:

npx table-builder --module="<шлях до модулю>" --scheme="<схема>"

Також є скорочена назва передачі параметрів:

npx table-builder -m="<шлях до модулю>" -t="<назва таблиці>" -s="<схема>"

| Аргумент | Скорочення | Опис | Приклад | | -------- | ---------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------- | | module | -m | Шлях, де будуть збережені вихідні файли. | Повний шлях: --module="D:/project/module/test", або відносний: --module="module/test" | | table | -t | Повна назва таблиці з бази даних. | --table="test.data" | | scheme | -s | Назва схеми з бази даних для пакетної генерації. | --scheme="test" |

Приклад

npx table-builder --module="D:\soft\module" --table="public.countries"

Що генерується

Для кожної таблиці <schema.table> утиліта створює:

• Таблиця → "{module}/table/<schema.table>.table.json"
• Форма → "{module}/form/<schema.table>.form.json"
• Картка → папка "{module}/card/<schema.table>.table/" з файлами:
  • index.yml — конфіг панелей/контейнерів;
  • info.hbs — шаблон (Handlebars) для відображення основної інформації.

Файли створюються лише якщо вони відсутні — існуючі файли не перезаписуються навмисно.

Конфігурація

Підключення до бази даних відбувається через конфігураційний файл (config.json) в самому проекті, де запускається ця команда. Формат файлу:

{ 
  "pg": {
    "host": "localhost",
    "port": 5432,
    "database": "назва_бази",
    "user": "користувач",
    "password": "пароль"
  }
}

Приклади

Згенерувати артефакти для однієї таблиці:

npx table-builder --module="./out" --table="public.countries"

Згенерувати артефакти для всіх таблиць у схемі:

npx table-builder --module="./out" --scheme="ato_new"

out/
├─ table/
│  └─ public.countries.table.json
├─ form/
│  └─ public.countries.form.json
└─ card/
   └─ public.countries.table/
      ├─ index.yml
      └─ info.hbs