Схема сокета Aggrega Wasm Linter
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json
Форматы передачи данных, которые принимает (LinterInput) и выдаёт (LinterOutput) сокет линтера. Линтер запускается во время публикации над парой сущностей «предыдущая версия + предлагаемая версия» (правило эволюции схемы) и во время линтинга рабочего пространства над отдельными сущностями (структурные правила для каждого правила). Один поставляемый плагин Wasm содержит множество правил; плагин выбирает, какое правило запустить, по LinterInput.rule_id. Эта схема — единственный источник обоих форматов передачи: типы полезной нагрузки для Go, Rust и TypeScript генерируются из неё в общий пакет plugin-ABI, и каждый набор для разработки плагинов реэкспортирует эти сгенерированные типы, а не объявляет собственную копию.
Одна из следующих форм
LinterInputLinterOutput
Определения
LinterInput
Полезная нагрузка, которую хост передаёт плагину publishing-linter при каждом вызове. rule_id выбирает правило, которому плагин передаёт обработку. entity_kind указывает вид проверяемой сущности (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed несёт разобранную структуру классифицируемой сущности (хост преобразует YAML в JSON перед отправкой; плагин никогда не видит сырых байтов). previous несёт разобранную сущность предыдущей версии для правила schema-evolution; опускается, когда неприменимо. implemented_component несёт связанную сущность другого вида — Component, который реализует проверяемый Recipe, — для правил, сравнивающих сущность с контрактом, объявленным другой сущностью; опускается, когда неприменимо. release и components несут остальную часть Release для правила, читающего его целиком: proposed тогда — это Aggregate, который развёртывает Release, release — сам этот Release, а components — Component, экземпляром которого является каждый экземпляр компонента в Aggregate; оба поля опускаются на всех прочих входных данных. policies несёт конфигурацию дисциплины публикации для рабочего пространства, к которой обращается правило.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
rule_id | string | да | Правило, которому плагин должен передать обработку, названное по своему идентификатору правила — тому же идентификатору в kebab-case, который результирующая находка несёт в rule_id, так что подавленное или выведенное в отчёт правило называется одинаково везде. Распознаваемый набор — это всё, что обрабатывает поставляемый плагин; идентификатор правила, который плагин не распознаёт, приводит к находке ‘unknown_rule’, а не к молчаливому прохождению. |
entity_kind | string (enum) | да | Вид сущности, который кодируют значения proposed/previous. Классификация правила schema-evolution зависит от вида; структурные правила ограничиваются определёнными видами. Допустимые значения: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate" |
proposed | object | да | Разобранная структура классифицируемой сущности. Хост преобразует YAML в JSON перед отправкой, поэтому плагин получает уже структурированное значение и никогда не видит сырых байтов. На входе правила, читающего Release целиком, это Aggregate, который развёртывает этот Release. На любом входе каждое значение параметра удаляется до передачи сущности, поскольку значение параметра может быть самими учётными данными, так что ни одно значение параметра не попадает к плагину-линтеру через это поле. Сущность Aggregate сохраняет свои объявления spec.parameters, каждое из которых содержит только те ключи, которые схема Aggregate допускает в объявлении параметра, кроме default, и к каждому объявлению, вложенному в properties, items и valuesType, применяется то же самое: default удаляется, а не заменяется, так что плагин не может определить, задаёт ли его объявление, а ключ, который схема там не допускает, удаляется вместе со всем своим содержимым. Блок parameters каждого модуля в spec.aggregates, несущий значения, передаваемые этому модулю, удаляется целиком, как и spec.parameters у сущности любого другого вида. Текст шаблонов, читающий параметр, сохраняется как написан. |
previous | object | нет | Разобранная структура сущности предыдущей версии для правил, выполняющих попарное сравнение (schema-evolution), со значениями параметров, удалёнными точно так же, как из proposed. Опускается, когда правилу не нужна ссылка на предыдущую версию (например, первая публикация, чисто структурные правила). |
implemented_component | object | нет | Разобранная структура сущности Component, которую проверяемый Recipe называет в spec.implements, разрешённая хостом. Это связанная сущность ДРУГОГО вида, чем проверяемая, и этим она отличается от previous: previous несёт другую версию той же сущности, а это поле несёт Component, объявленный выходной контракт которого реализует Recipe. Хост разрешает её через тот же поиск по каталогу, что и сборка, по имени Component, так что все три формы закрепления, которые принимает spec.implements (без версии, точная, диапазон, совместимый по мажорной версии), приводят к одной и той же записи. Опускается, когда проверяемая сущность не является Recipe, когда она не называет Component или когда Component с таким именем недоступен в каталоговых директориях рабочего пространства. Отсутствующее значение означает, что сравнение недоступно, а не что контракт пуст: правило, читающее это поле, не выдаёт находок, когда оно отсутствует. |
release | object | нет | Разобранная структура сущности Release, которую называет проверка уровня релиза, со свёрнутой цепочкой extends, так что дочерний Release несёт то, что наследует от базового. Хост преобразует её из YAML в JSON так же, как proposed. Её блок spec.parameters содержит значения, заполняющие параметры Aggregate, поэтому он удаляется целиком до передачи Release: значение параметра может быть самими учётными данными, ни одно правило этот блок не читает, и поэтому ни одно значение параметра не попадает к плагину-линтеру через это поле. Присутствует только на входе правила, читающего Release целиком, где proposed — это Aggregate, который развёртывает этот Release, со значениями параметров, удалёнными так, как описано для proposed; опускается на всех прочих входах. |
components | map of object | нет | Сущность Component, экземпляром которой является каждый экземпляр компонента в Aggregate, с ключом по имени экземпляра, которое ему даёт Aggregate, — это тот же ключ, что используют собственные карты components сущностей Aggregate и Release. Каждое значение — это Component, к которому разрешается тип экземпляра, со свёрнутой цепочкой extends, если она есть, преобразованный в JSON так же, как implemented_component. Экземпляр, чей Component недоступен в каталоговых директориях рабочего пространства, отсутствует, и правило трактует это отсутствие как недоступность, а не как Component, ничего не объявляющий. Присутствует только рядом с release, на входе правила, читающего Release целиком; опускается на всех прочих входах. |
source_path | string | нет | Путь в файловой системе, из которого загружена сущность. Заполняется вызывающими сторонами хоста, обходящими файловую систему каталога; используется правилами, учитывающими путь (например, category-matches-directory). Опускается, когда у вызывающей стороны нет контекста пути. |
policies | Policies | нет | Конфигурация дисциплины публикации для рабочего пространства, к которой обращается правило, передаваемая в виде объекта Policies, который хост собирает из конфигурации рабочего пространства и любых переопределений из командной строки. |
Дополнительные свойства не допускаются.
LinterOutput
Форма ответа, которую выдаёт плагин publishing-linter. findings несёт по одной записи на каждый вызов правила, давший результат. Правило schema-evolution выдаёт ровно одну находку (вердикт классификации); структурные правила могут выдать ноль (нет нарушений) или много (по одной на каждое нарушение).
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
findings | Diagnostic[] | да | Находки по правилам, полученные в результате вызова плагина, в порядке их выдачи плагином. |
error | string | нет | Сообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина. |
Дополнительные свойства не допускаются.
Policies
Конфигурация дисциплины публикации на уровне рабочего пространства, к которой обращается набор правил; хост собирает её из параметров дисциплины публикации в конфигурации рабочего пространства и любых переопределений из командной строки. Эта схема является контрактом для формы. При отсутствии поля каждый флаг по умолчанию равен false, и хост записывает только поля, значение которых отличается от значения по умолчанию.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
allow_dynamic_refs | логическая | нет | Если true, использование $dynamicAnchor / $dynamicRef в записях SchemaLibrary допускается (подавляет правило dynamic-refs). По умолчанию false. |
allow_id_overrides | логическая | нет | Если true, переопределения $id в записях SchemaLibrary допускаются (подавляет правило id-overrides). По умолчанию false. |
allow_direct_x_aggrega_extensions | логическая | нет | Если true, прямое написание x-aggrega-selector / x-aggrega-inject допускается (подавляет правило x-aggrega-discouragement). По умолчанию false. |
allow_aggrega_ai_prefix | логическая | нет | Если true, правило annotation-prefix подавляется полностью (и проверка голого префикса aggrega.ai/, и зависящая от вида проверка feature.aggrega.ai/). По умолчанию false. |
allow_nonstandard_names | логическая | нет | Если true, нарушения формы имени допускаются (подавляет правило name-shape). По умолчанию false. |
allow_category_mismatches | логическая | нет | Если true, подавляет находки правила category-matches-directory. Соглашение стандартного каталога требует, чтобы Components в core/ |
allow_undeclared_recipe_provides | логическая | нет | Если true, подавляет находки правила provides-declared-by-component. Это правило сообщает о каждом ключе, который сущность Recipe публикует в spec.provides и который сущность Component, названная в её spec.implements, не объявляет в разделе provides своей spec.schema. Публикация сверх объявленного контракта принимается при сборке, поэтому находка носит рекомендательный характер; рабочее пространство, чьи Recipes намеренно публикуют ключи, не объявленные их сущностью Component, отказывается от правила здесь. По умолчанию false. |
allow_connection_credential_mismatches | логическая | нет | Если true, подавляет находки правила connection-credential-matches-target-key. Это правило читает сущность Release целиком и для каждого соединения, цель которого объявляет ключ, требуемый от вызывающих, сравнивает учётные данные, предъявляемые соединением, с ключом, который хранит цель: оно сообщает о двух концах, называющих разные секреты, и о ключе, объявленном только на одном конце. Согласованность двух концов — это соглашение каталога, а не то, что проверяет сборка, поэтому находка носит рекомендательный характер; рабочее пространство, у которого два конца намеренно различаются, отказывается от правила здесь. По умолчанию false. |
Дополнительные свойства не допускаются.