Tovább a tartalomhoz

Kódgenerálás

A Kód szakaszból a Restorm generálja az alkalmazása kódját a terve alapján. A generálás Cookiecutter/Copier-kompatibilis sablonokra támaszkodik: a sajátjaira, vagy a Restorm által kínáltakra.

A Kód szakasz: egy hozzáadott sablon, egy kimeneti mappa és a generált fastruktúra előnézete írás előtt

  1. Adjon hozzá egy vagy több sablont — a sablonkönyvtáron keresztül.
  2. Válasszon egy kimeneti mappát (abszolút, vagy a projekthez viszonyított).
  3. Kattintson a Projekt generálása gombra.

A generálás egy sandboxban renderelődik, majd előnézet formájában áll elő: a Restorm megmutatja a generált fájlok fastruktúráját, és semmit sem ír, amíg meg nem erősítette. Ezután Írhat a kimeneti mappába vagy Elvethet. (A generálás blokkolva van, amíg validációs problémák maradnak.)

Egy sablon deklarálhat kérdéseket (Copier értelemben — például egy project_slug), amelyekre a generálás pillanatában válaszol. A válaszait egy .copier-answers.yml fájlba mentjük a kimenet gyökerében, és a következő generáláskor újratöltjük őket.

A generálás nem egyirányú. Az újragenerálás egy copier update szerepét tölti be: a Restorm megjegyez egy alapot, és háromutas összefésülést végez a sablon új kimenete és a helyi módosításai között — a változtatásait tehát nem írja felül. Fejleszti a tervét (vagy a sablont), újragenerál, és a kód frissül, megőrizve a munkáját.

A sablonkönyvtár négy forrást kínál:

  • Hivatalos — a Restorm által karbantartott sablonok, mindenki számára láthatók.
  • Szervezet — a szervezetén belül megosztott sablonok, a tagjai számára privátak. Ez egy Enterprise funkció: egy admin — vagy egy sablonok kezelése jogosultsággal rendelkező tag — adja hozzá vagy távolítja el őket (a tároló URL-je + leírás), a könyvtár Sablonok <szervezet> lapjáról vagy az adminisztrációs vezérlőpultból. Lásd Hivatalos és szervezeti sablonok.
  • Tároló — egy GitHub tároló tulajdonos/név (jellemzően egy hivatalos sablon általad adaptált forkja).
  • Helyi mappa — egy fejlesztés alatt álló sablon, hálózat nélkül.

Egy sablon szerkezetét és a hivatalos katalógust a Hivatalos sablonok oldal írja le. Azt, hogy egy sablon mit kap a tervéből (modellek, útvonalak és a jelzőik), A sablon kontextusa oldal részletezi, a sablonhoz tartozó saját beállításokat pedig a Generálási változók oldal.