Přeskočit na obsah

Generování kódu

Ze sekce Kód Restorm generuje kód vaší aplikace na základě vašeho návrhu. Generování se opírá o šablony kompatibilní s Cookiecutter/Copier: vaše vlastní nebo ty nabízené Restormem.

Sekce Kód: přidaná šablona, výstupní složka a náhled generovaného stromu souborů před zápisem

  1. Přidejte jednu nebo více šablon — prostřednictvím knihovny šablon.
  2. Zvolte výstupní složku (absolutní nebo relativní vůči projektu).
  3. Klikněte na Generovat projekt.

Generování je vykresleno v sandboxu a poté vytvořeno ve formě náhledu: Restorm vám ukáže strom generovaných souborů a nic nezapíše, dokud nepotvrdíte. Můžete pak Zapsat do výstupní složky nebo Zahodit. (Generování je zablokováno, dokud přetrvávají problémy s validací.)

Šablona může deklarovat otázky (ve smyslu Copier — například project_slug), na které odpovídáte ve chvíli generování. Vaše odpovědi jsou uloženy v souboru .copier-answers.yml v kořeni výstupu a znovu načteny při dalším generování.

Generování není jednosměrné. Opětovné generování plní roli copier update: Restorm si zapamatuje základ a provede tříbodové sloučení mezi novým výstupem šablony a vašimi lokálními úpravami — vaše změny tedy nejsou přepsány. Rozvíjíte svůj návrh (nebo šablonu), generujete znovu a kód se aktualizuje se zachováním vaší práce.

Knihovna šablon nabízí čtyři zdroje:

  • Oficiální — šablony udržované Restormem, viditelné pro všechny.
  • Organizace — šablony sdílené v rámci vaší organizace, soukromé pro její členy. Je to funkce Enterprise: admin — nebo člen s oprávněním spravovat šablony — je přidává nebo odebírá (URL repozitáře + popis) ze záložky Šablony <organizace> knihovny nebo z administrátorského panelu. Viz Oficiální šablony a šablony organizace.
  • Repozitář — GitHub repozitář vlastník/název (typicky fork oficiální šablony, který jste upravili).
  • Lokální složka — šablona ve vývoji, bez sítě.

Struktura šablony a oficiální katalog jsou popsány na stránce Oficiální šablony. To, co šablona dostává z vašeho návrhu (modely, trasy a jejich příznaky), je popsáno v Kontext šablony a nastavení specifická pro šablonu ve Proměnné generování.