Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема сокета 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, і кожен набір для плагінів реекспортує ці згенеровані типи, а не оголошує власну копію.

Одна з наведених нижче форм

  • LinterInput
  • LinterOutput

Визначення

LinterInput

Корисне навантаження, яке хост передає плагіну лінтера публікації під час кожного виклику. rule_id вибирає правило, до якого плагін спрямовує виклик. entity_kind визначає тип сутності, що перевіряється (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed містить розібрану структуру сутності, що класифікується (хост перетворює YAML на JSON перед надсиланням; плагін ніколи не бачить сирих байтів). previous містить розібрану сутність попередньої версії для правила еволюції схеми; пропускається, коли незастосовне. implemented_component містить пов’язану сутність іншого типу — сутність Component, яку реалізує перевірювана сутність Recipe, — для правил, що порівнюють сутність із контрактом, який оголошує інша сутність; пропускається, коли незастосовне. release і components містять решту сутності Release для правила, яке читає її цілком: proposed тоді є сутністю Aggregate, яку розгортає Release, release — цією сутністю Release, а components — сутністю Component, екземпляром якої є кожен екземпляр компонента сутності Aggregate; обидва пропускаються в усіх інших вхідних даних. policies містить конфігурацію дисципліни публікації для робочого простору, до якої звертається правило.

ВластивістьТипОбов’язковаОпис
rule_idstringтакПравило, до якого плагін має спрямувати виклик, назване за своїм ідентифікатором — тим самим ідентифікатором у kebab-case, який результівна знахідка містить у rule_id, тож приглушене чи повідомлене правило називається однаково на кожній поверхні. Набір розпізнаних правил — це ті, які обробляє постачений плагін; ідентифікатор правила, який плагін не розпізнає, дає знахідку ‘unknown_rule’, а не мовчазне проходження.
entity_kindstring (enum)такТип сутності, який кодують значення proposed/previous. Класифікація правила еволюції схеми залежить від типу; структурні правила стосуються певних типів. Дозволені значення: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectтакРозібрана структура сутності, що класифікується. Хост перетворює YAML на JSON перед надсиланням, тож плагін отримує вже структуроване значення й ніколи не бачить сирих байтів. У вхідних даних правила, яке читає цілу сутність Release, це сутність Aggregate, яку розгортає ця Release. У будь-яких вхідних даних кожне значення параметра видаляється перед передаванням сутності, бо значенням параметра може бути сам обліковий секрет, тож жодне значення параметра не потрапляє до плагіна лінтера через це поле. Сутність Aggregate зберігає свої оголошення spec.parameters, кожне з яких містить лише ключі, що їх схема Aggregate допускає в оголошенні параметра, крім default, і до кожного оголошення, вкладеного в properties, items і valuesType, застосовується те саме: default видаляється, а не замінюється, тож плагін не може визначити, чи оголошення його задає, а ключ, який схема там не допускає, видаляється разом із усім, що він містить. Блок parameters кожного модуля в spec.aggregates, що містить значення, передані цьому модулю, видаляється цілком, як і spec.parameters у сутності будь-якого іншого типу. Текст шаблону, що читає параметр, зберігається як написано.
previousobjectніРозібрана структура сутності попередньої версії для правил, що виконують попарне порівняння (еволюція схеми), зі значеннями параметрів, видаленими так само, як із proposed. Пропускається, коли правилу не потрібне посилання на попередню версію (наприклад, перша публікація, суто структурні правила).
implemented_componentobjectніРозібрана структура сутності Component, яку перевірювана сутність Recipe називає в spec.implements, визначена хостом. Це пов’язана сутність ІНШОГО типу, ніж перевірювана, і саме це відрізняє її від previous: previous містить іншу версію тієї самої сутності, тоді як це поле містить сутність Component, оголошений вихідний контракт якої реалізує Recipe. Хост визначає її тим самим пошуком у каталозі, що й збірка, за іменем Component, тож усі три форми закріплення, які приймає spec.implements (без версії, точна, діапазон, сумісний за мажорною версією), ведуть до того самого запису. Пропускається, коли перевірювана сутність не є Recipe, коли вона не називає жодної сутності Component або коли жодна сутність Component із цим іменем недосяжна в каталогах робочого простору. Відсутнє значення означає, що порівняння недоступне, а не що контракт порожній: правило, яке читає це поле, не видає знахідок, коли воно відсутнє.
releaseobjectніРозібрана структура сутності Release, яку називає перевірка рівня релізу, з урахованим ланцюжком extends, тож дочірня сутність Release містить те, що успадковує від базової. Хост перетворює її з YAML на JSON так само, як proposed. Її блок spec.parameters містить значення, що задовольняють параметри сутності Aggregate, тому він видаляється цілком перед передаванням Release: значенням параметра може бути сам обліковий секрет, жодне правило не читає цей блок, і тому жодне значення параметра не потрапляє до плагіна лінтера через це поле. Присутнє лише у вхідних даних правила, яке читає цілу сутність Release, де proposed є сутністю Aggregate, яку розгортає ця Release, зі значеннями параметрів, видаленими, як описано для proposed; пропускається в усіх інших вхідних даних.
componentsmap of objectніСутність Component, екземпляром якої є кожен екземпляр компонента сутності Aggregate, з ключем — іменем екземпляра, яке дає йому Aggregate, тобто тим самим ключем, що його використовують власні мапи components сутностей Aggregate і Release. Кожне значення — це сутність Component, до якої зводиться тип екземпляра, з урахованим ланцюжком extends, перетворена на JSON так само, як implemented_component. Екземпляр, чия сутність Component недосяжна в каталогах робочого простору, відсутній, і правило трактує цю відсутність як недоступність, а не як сутність Component, що нічого не оголошує. Присутнє лише поряд із release, у вхідних даних правила, яке читає цілу сутність Release; пропускається в усіх інших вхідних даних.
source_pathstringніШлях у файловій системі, з якого завантажено сутність. Заповнюється викликачами на боці хоста, що обходять файлову систему каталогу; використовується правилами, що враховують шлях (наприклад, category-matches-directory). Пропускається, коли викликач не має контексту шляху.
policiesPoliciesніКонфігурація дисципліни публікації для робочого простору, до якої звертається правило, передана як об’єкт Policies, який хост складає з конфігурації робочого простору та будь-яких перевизначень із командного рядка.

Додаткові властивості не дозволені.

LinterOutput

Форма відповіді, яку видає плагін лінтера публікації. findings містить один запис на кожен виклик правила, що дав результат. Правило еволюції схеми видає рівно одну знахідку (вердикт класифікації); структурні правила можуть видати нуль (немає порушень) або багато (по одній на кожне порушення).

ВластивістьТипОбов’язковаОпис
findingsDiagnostic[]такЗнахідки за правилами, отримані під час виклику плагіна, у порядку їх видачі плагіном.
errorstringніПовідомлення про збій, що задається, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від будь-якої діагностики у виводі: діагностика повідомляє про проблеми, виявлені під час виконання, яке все ж дало результат, тоді як 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// оголошували component.aggrega.ai/category={category}, що відповідає сегменту каталогу, де {category} — одне з 15 значень закритого набору. Робочі простори з обґрунтованими постійними винятками відмовляються від нього тут. Типово false.
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.

Додаткові властивості не дозволені.