Перейти до вмісту

Генерація коду

З розділу Код Restorm генерує код вашого застосунку на основі вашого проєкту. Генерація спирається на шаблони, сумісні з Cookiecutter/Copier: ваші власні або запропоновані Restorm.

Розділ Код: доданий шаблон, тека виводу та попередній перегляд згенерованого дерева перед записом

  1. Додайте один або кілька шаблонів — через бібліотеку шаблонів.
  2. Виберіть теку виводу (абсолютну або відносну до проєкту).
  3. Натисніть Згенерувати проєкт.

Генерація рендериться в пісочниці, а потім видається у формі попереднього перегляду: Restorm показує вам дерево згенерованих файлів і нічого не записує, доки ви не підтвердите. Тоді ви можете Записати в теку виводу або Скасувати. (Генерація заблокована, доки залишаються проблеми валідації.)

Шаблон може оголошувати питання (у розумінні Copier — наприклад, project_slug), на які ви відповідаєте в момент генерації. Ваші відповіді записуються у файл .copier-answers.yml у корені виводу і перезавантажуються при наступній генерації.

Оновлення згенерованого коду

Section titled “Оновлення згенерованого коду”

Генерація не одностороння. Повторна генерація відіграє роль copier update: Restorm запам’ятовує базу і виконує тристороннє злиття між новим виводом шаблону та вашими локальними змінами — отже, ваші зміни не перезаписуються. Ви розвиваєте ваш проєкт (або шаблон), генеруєте повторно, і код оновлюється, зберігаючи вашу роботу.

Звідки береться шаблон

Section titled “Звідки береться шаблон”

Бібліотека шаблонів пропонує чотири джерела:

  • Офіційний — шаблони, які підтримує Restorm, видимі всім.
  • Організація — шаблони, спільні в межах вашої організації, приватні для її учасників. Це функція Enterprise: адміністратор — або учасник, який має право керувати шаблонами — додає чи прибирає їх (URL репозиторію + опис), зі вкладки Шаблони <організація> бібліотеки чи з панелі адміністрування. Див. Офіційні шаблони та шаблони організації.
  • Репозиторій — репозиторій GitHub власник/назва (зазвичай форк офіційного шаблону, який ви адаптували).
  • Локальна тека — шаблон у процесі розробки, без мережі.

Структуру шаблону та офіційний каталог описано на сторінці Офіційні шаблони. Те, що шаблон отримує з вашого проєкту (моделі, маршрути та їхні прапорці), детально викладено в Контекст шаблону, а налаштування, властиві самому шаблону, — у Змінні генерації.