Przejdź do głównej zawartości

Generowanie kodu

W sekcji Kod Restorm generuje kod Pana/Pani aplikacji na podstawie Pana/Pani projektu. Generowanie opiera się na szablonach zgodnych z Cookiecutter/Copier: Pana/Pani własnych lub tych proponowanych przez Restorm.

Sekcja Kod: dodany szablon, folder wyjściowy oraz podgląd wygenerowanego drzewa plików przed zapisem

  1. Proszę dodać jeden lub kilka szablonów — za pośrednictwem biblioteki szablonów.
  2. Proszę wybrać folder wyjściowy (bezwzględny lub względny wobec projektu).
  3. Proszę kliknąć Generuj projekt.

Generowanie jest renderowane w piaskownicy, a następnie wytwarzane w postaci podglądu: Restorm pokazuje Panu/Pani drzewo wygenerowanych plików i niczego nie zapisuje, dopóki Pan/Pani nie potwierdzi. Może Pan/Pani wtedy Zapisać do folderu wyjściowego lub Porzucić. (Generowanie jest zablokowane, dopóki pozostają problemy z walidacją.)

Szablon może deklarować pytania (w rozumieniu Copier — na przykład project_slug), na które odpowiada Pan/Pani w momencie generowania. Pana/Pani odpowiedzi są zapisywane w pliku .copier-answers.yml w katalogu głównym wyjścia i wczytywane ponownie przy kolejnym generowaniu.

Generowanie nie jest jednokierunkowe. Ponowne generowanie pełni rolę copier update: Restorm zapamiętuje bazę i wykonuje scalanie trójstronne między nowym wynikiem szablonu a Pana/Pani lokalnymi modyfikacjami — Pana/Pani zmiany nie są więc nadpisywane. Rozwija Pan/Pani swój projekt (lub szablon), generuje ponownie, a kod aktualizuje się, zachowując Pana/Pani pracę.

Biblioteka szablonów oferuje cztery źródła:

  • Oficjalne — szablony utrzymywane przez Restorm, widoczne dla wszystkich.
  • Organizacja — szablony współdzielone w ramach Pana/Pani organizacji, prywatne dla jej członków. To funkcja Enterprise: admin — lub członek posiadający uprawnienie zarządzaj szablonami — dodaje je lub usuwa (URL repozytorium + opis) z zakładki Szablony <organizacji> biblioteki lub z panelu administracyjnego. Zobacz Szablony oficjalne i organizacji.
  • Repozytorium — repozytorium GitHub właściciel/nazwa (zwykle fork oficjalnego szablonu, który dostosowano).
  • Folder lokalny — szablon w trakcie rozwoju, bez sieci.

Struktura szablonu i oficjalny katalog są opisane na stronie Szablony oficjalne. To, co szablon otrzymuje z Pana/Pani projektu (modele, trasy i ich flagi), jest opisane w Kontekst szablonu, a ustawienia specyficzne dla szablonu w Zmienne generowania.