Szablony — przegląd
Autorzy encji Recipe i FeatureRecipe piszą kod Go text/template w określonych miejscach ewaluacji: we wpisach provides, we wpisach locals, w valuesMapping (inline lub ładowanym przez $import:), w treści workload: (inline lub ładowanej przez $import:), we wpisach artifacts: (inline lub ładowanych przez $import: dla każdego wpisu), w injectMapping encji FeatureRecipe, w source:, we wpisach assertions: oraz w with: i when: każdego kroku pipeline:. Każde miejsce jest wykonywane w określonej fazie potoku kompilacji i otrzymuje określony widok kontekstu filarów. Ten zestaw rozdziałów dokumentuje powierzchnię szablonów: gdzie szablony są wykonywane, co kontekst udostępnia w każdym miejscu i jakie funkcje pomocnicze są dostępne.
Kształt kontekstu szablonu i kolejność ewaluacji to kontrakty nośne — zmiana któregokolwiek z nich psuje każdy istniejący szablon encji Recipe. Kontekst szablonu jest formalnie zdefiniowany w schemacie JSON Schema dostarczanym z kompilatorem; macierz ewaluacji dla poszczególnych miejsc opisuje, które filary są dostępne do odczytu w którym miejscu, a silnik szablonów Go jest dostarczany z biblioteką funkcji pomocniczych Sprig oraz rozszerzeniami specyficznymi dla Aggrega. Etapy potoku, na których opierają się te miejsca ewaluacji, są opisane na poziomie architektury w ../architecture/10-compilation-pipeline.md — mapowanie wstrzykiwania dla injectMapping encji FeatureRecipe, preambuła locals i rozwiązywanie źródeł dla .locals i .source encji Recipe, renderowanie bazowe dla valuesMapping bazowej encji Recipe oraz renderowanie funkcji dla generowania zasobów (Resource Generation) encji FeatureRecipe.
Dokumentacja według tematów
- Macierz rozwijania szablonów — wiążąca tabela dla poszczególnych miejsc, obejmująca każdy punkt ewaluacji szablonów, filary odczytywane w danym miejscu oraz sposób, w jaki wyniki trafiają do grafu IR lub dalszych podprzebiegów.
- Kontrakt kontekstu szablonu — formalny kształt kontekstu szablonu, który kompilator przekazuje szablonom, w tym dwustanowa para
.inject/.inject_raworaz wzbogacona projekcja JOIN.context.uses. - Nazywanie renderowanego zasobu — który z dwóch kluczy tożsamości nazywa co, różnica między celem
usesa referencją publikowaną przez producenta, którzy dostawcy zgłaszają nazwę renderowanych przez siebie zasobów i dlaczego pozostali nie zgłaszają żadnej, oraz zatrzymanie, które odrzuca klucz tam, gdzie taka nazwa nie istnieje. - Funkcje Sprig i funkcje pomocnicze — funkcje pomocnicze Sprig dostępne w szablonach Go oraz rozszerzenia specyficzne dla Aggrega i funkcje pomocnicze zapewniające bezpieczeństwo, sposób, w jaki zapisana przez autora liczba jest odczytywana, wypisywana i porównywana w szablonie wartości, a także to, które funkcje pomocnicze sprawdzają, czy wartość została zapisana, a które — czy jest pusta.
- Kontekst szablonu dla parametrów — gdzie wartości
parameters:wypełnione przez encję Release trafiają do szablonu: są interpolowane do szablonów wartości przed ich wykonaniem, a bezpośrednio odczytują je tylko szablony ścieżek. - Blok
assertions:— nazwane reguły międzypolowe, które encja Component, Feature, Recipe lub FeatureRecipe deklaruje jako szablony, ewaluowane przed renderowaniem.