Обзор шаблонов
Авторы сущностей Recipe и FeatureRecipe пишут код на Go text/template в определённых местах вычисления: в записях provides, записях locals, в valuesMapping (встроенном или загруженном через $import:), в содержимом workload: (встроенном или загруженном через $import:), в записях artifacts: (встроенных или загруженных через $import: для каждой записи), в injectMapping сущности FeatureRecipe, в source:, в записях assertions:, а также в with: и when: каждого шага pipeline:. Каждое место выполняется на определённой фазе конвейера компиляции и получает определённое представление контекста опор. Этот набор глав документирует поверхность шаблонов: где выполняются шаблоны, что контекст предоставляет в каждом месте и какие вспомогательные функции доступны.
Форма контекста шаблонов и порядок вычисления — несущие контракты: изменение любого из них ломает каждый существующий шаблон Recipe. Контекст шаблонов формально определён в JSON Schema, поставляемой вместе с компилятором; матрица вычисления по местам описывает, какие опоры доступны для чтения в каком месте, а движок шаблонов Go поставляется с библиотекой вспомогательных функций Sprig и расширениями, специфичными для Aggrega. Этапы конвейера, к которым привязаны эти места вычисления, описаны на уровне архитектуры в ../architecture/10-compilation-pipeline.md: сопоставление внедрения — для injectMapping сущности FeatureRecipe, преамбула locals и разрешение источников — для .locals и .source сущности Recipe, базовый рендеринг — для valuesMapping базовой сущности Recipe, а рендеринг функций — для генерации ресурсов сущности FeatureRecipe.
Справочник по темам
- Матрица раскрытия шаблонов — авторитетная таблица по местам, охватывающая каждую точку вычисления шаблонов: какие опоры читает это место и как выходные данные попадают в граф IR или в последующие подпроходы.
- Контракт контекста шаблонов — формальная форма контекста шаблонов, который компилятор передаёт шаблонам, включая пару двойного состояния
.inject/.inject_rawи обогащённую проекцию JOIN.context.uses. - Именование отрендеренного ресурса — какой из двух ключей идентичности что именует, разница между целью
usesи ссылкой, которую публикует производитель, какие провайдеры сообщают имя для отрендеренных ими ресурсов и почему остальные не сообщают никакого, а также остановка, отклоняющая ключ там, где такого имени нет. - Функции и вспомогательные функции Sprig — вспомогательные функции Sprig, доступные внутри шаблонов Go, а также расширения, специфичные для Aggrega, и вспомогательные функции безопасности; как записанное автором число читается, выводится и сравнивается в шаблоне значения; какие вспомогательные функции проверяют, было ли значение записано, а какие — пусто ли оно.
- Контекст шаблонов для параметров — где значения
parameters:, заполненные сущностью Release, попадают в шаблон: они подставляются в шаблоны значений до их выполнения и читаются напрямую только шаблонами путей. - Блок
assertions:— именованные межполевые правила, которые сущность Component, Feature, Recipe или FeatureRecipe объявляет в виде шаблонов; они вычисляются до рендеринга.