@reformer/builder 2.0.0 → 3.0.0-beta.2

package/README.md

@@ -61,6 +61,36 @@ npm run builder
   Arc, Brave).
 - **Mode A** — создать новую схему с нуля и выгрузить/скопировать JSON или сгенерированный код.
 
+## Шаблоны форм
+
+Новая форма создаётся из **шаблона** — набора файлов с плейсхолдерами вместо имени формы. Панель
+«Шаблоны» в левом сайдбаре показывает все доступные шаблоны, генерация — ПКМ в дереве файлов →
+«Сгенерировать → Выбрать шаблон…» (имя формы, шаблон и какие его файлы создать).
+
+Три источника шаблонов:
+
+- **встроенные** — «Простая форма» (одна страница полей) и «Пошаговая форма» (визард на два шага с
+  адаптером к ui-kit `FormWizard`). Оба дают полный набор: модель, схема, валидация, поведение формы
+  и UI, реестр, страница-компонент — она тянет остальные файлы, без них не соберётся;
+- **проект** — папки в `.reformer/templates/<slug>/` (каталог переопределяется
+  `project.templatesDir`). Обычные файлы + `template.json` с именем и описанием: шаблон едет в git,
+  правится руками в IDE и работает у всей команды;
+- **локальный** — сохранённый в IndexedDB браузера, доступен и без открытого проекта.
+
+Свой шаблон делается из готовой формы: выделить её файлы в дереве (⌘/Ctrl+клик — добавить к выбору,
+⇧+клик — диапазон) → ПКМ → «Создать шаблон…». Имя формы-источника (базовое имя) заменяется
+плейсхолдерами во всех написаниях, чтобы при генерации подставлялось имя новой формы:
+
+| Плейсхолдер     | Форма `user-profile` |
+| --------------- | -------------------- |
+| `__FormName__`  | `UserProfile`        |
+| `__formName__`  | `userProfile`        |
+| `__form-name__` | `user-profile`       |
+| `__form_name__` | `user_profile`       |
+
+Плейсхолдеры работают и в именах файлов (`__form-name__.css`), поэтому шаблон переживает любое имя
+новой формы. Бинарные файлы (картинки, шрифты) в шаблон не попадают.
+
 ## Каталог компонентов (`@reformer/ui-kit/catalog`)
 
 Палитра билдера строится из **каталога компонентов** `@reformer/ui-kit` — это
@@ -75,6 +105,10 @@ npm run builder
 каталог можно **переопределить при локальном старте** флагом `--catalog` (см. ниже) — без
 пересборки билдера.
 
+`@reformer/ui-kit` — не единственный вариант: билдер держит несколько китов и версий, активный
+выбирается в переключателе тулбара. Как подключить свой кит — другую версию, форк или стороннюю
+дизайн-систему — см. [docs/instructions/add-ui-kit.md](docs/instructions/add-ui-kit.md).
+
 ## Локальная кастомизация (`--catalog` / `--config`)
 
 Клиент может передать при локальном старте два JSON-файла — они читаются launcher'ом и
@@ -116,8 +150,12 @@ npm run builder
   },
   // Дефолты интерфейса при старте
   "ui": { "theme": "light", "leftPanel": "palette", "rightOpen": true, "preview": "wire" },
-  // Работа с проектом (Mode B discovery) + стартовая схема Mode A (null — пустая форма)
-  "project": { "ignoreDirs": ["fixtures"], "seedSchema": null },
+  // Работа с проектом (Mode B discovery), каталог шаблонов + стартовая схема Mode A (null — пустая форма)
+  "project": {
+    "ignoreDirs": ["fixtures"],
+    "templatesDir": ".reformer/templates",
+    "seedSchema": null,
+  },
 }
 ```