Спільна схема діагностики для Wasm-плагінів Aggrega
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json
Єдина форма діагностики, спільна для всіх сокетів Wasm. Плагін повідомляє один запис на кожну виявлену проблему; хост її відображає. Форма є надмножиною: кожен сокет заповнює підмножину, яку використовує, і пропускає решту, тож діагностика від будь-якого сокета має одну однорідну структуру. severity — одне з трьох значень, спільних для всіх сокетів, — halt, warn або info, тож діагностика має однакове значення незалежно від того, який сокет її створив.
Тип верхнього рівня: object
Визначення
Diagnostic
Одна проблема, яку виявило джерело діагностики: рівень серйозності, зрозуміле людині повідомлення, необов’язкове розташування та необов’язкові поля, специфічні для джерела. Джерелом є сокет Wasm-плагіна або сам компілятор — обидва звітують у цій одній формі, тож читач тлумачить запис однаково, хоч би хто його створив. Кожне заповнює підмножину, яку використовує, і пропускає решту: парсер задає діапазон розташування, імпорт задає code і source_ref, лінтер публікації задає rule_id і classification, вердикт управління задає severity результату збірки та message і може додати будь-що з code, rule_id, classification, source_ref, location і suggest, а попередження рендерингу задає code, source_ref і структуроване розташування.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
severity | string (enum) | так | Рівень серйозності діагностики з одного закритого набору, спільного для всіх сокетів. halt зупиняє збірку й називає, що слід виправити. warn відображається поряд зі збіркою, яка все одно завершується. info фіксує спостереження і не змінює результату збірки. Кожне джерело звітує з цього одного набору, тож читач тлумачить рівень серйозності однаково, хоч би хто його створив. Дозволені значення: "halt", "warn", "info" |
message | string | так | Зрозумілий людині текст діагностики. |
code | string | ні | Необов’язковий стабільний, придатний для машинного зіставлення код діагностики, незалежний від зрозумілого людині повідомлення. Відсутній, коли джерело не призначає коду. Код може надходити від сокета плагіна або від власних попереджень компілятора, які задають його в кожному створеному записі. |
rule_id | string | ні | Ідентифікатор правила, яке створило діагностику, коли джерело базується на правилах (лінтер публікації). В іншому разі відсутній. |
classification | string (enum) | ні | Класифікація впливу на семантичну версію, яку містить діагностика, коли правило-джерело її призначає (правило еволюції схеми). Відсутня для діагностик без класифікації. Дозволені значення: "PATCH", "MINOR", "MAJOR" |
source_ref | string | ні | Непрозоре посилання на елемент джерела, якого стосується діагностика (наприклад, ідентифікатор вузла джерела, який імпорт не зміг розв’язати). Відсутнє, коли діагностика не посилається на конкретний елемент джерела. |
location | Location | ні | Місце, на яке вказує діагностика, коли джерело може визначити розташування проблеми. Парсер заповнює діапазон байтів; рендерер заповнює структуровану позицію в документі джерела. Відсутнє, коли діагностика не має розташування. |
suggest | string | ні | Необов’язкова підказка щодо виправлення, яку джерело пропонує разом із діагностикою. Відсутня, коли підказки немає. |
Додаткові властивості не дозволені.
Location
Місце, на яке вказує діагностика. Містить один уніфікований локатор, що слугує як для побайтово точної позиції в сирому тексті джерела (парсер заповнює span), так і для структурованої позиції в документі джерела (рендерер заповнює key_path, uri, line і kind), і називає екземпляр збірки, якого стосується діагностика, якщо такий є (instance). Усі поля необов’язкові; сокет заповнює те подання, яке може створити, і пропускає решту.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
span | Span | ні | Діапазон сирих байтів джерела, який визначає діагностика, коли джерело розбирає вихідний текст і може прив’язати проблему до діапазону байтів (парсер). В іншому разі відсутній. |
key_path | string | ні | Шлях через крапку до проблемного елемента в структурованому документі джерела, коли джерело визначає розташування проблеми структурно (рендерер). В іншому разі відсутній. |
uri | string | ні | Ідентифікатор артефакту джерела, якого стосується діагностика, коли джерело його знає (рендерер). В іншому разі відсутній. Він ніколи не називає екземпляр збірки; це робить instance. |
line | integer | ні | Номер рядка в структурованому документі джерела, відмінний від рядка й стовпця сирих байтів, які містить span. Присутній, коли джерело знає рядок документа (рендерер). В іншому разі відсутній. |
kind | string | ні | Відкритий рядок, що називає поверхню джерела, до якої належить розташування, коли джерело розрізняє поверхні (рендерер). В іншому разі відсутній. |
instance | string | ні | Екземпляр збірки, якого стосується діагностика, за ідентичністю, яку йому дає збірка: компонент — за іменем, під яким його оголошує сутність Aggregate, компонент, який додає модуль, — за його шляхом через модуль, записаним через крапки, компонент, який виводить збірка, — за ідентичністю, яку збірка для нього складає, а модуль — за його власним шляхом. Присутній, коли діагностика стосується одного екземпляра; в іншому разі відсутній. |
Додаткові властивості не дозволені.
Span
Діапазон байтів початкового джерела: зміщення в байтах є основним, точним розташуванням, а номери рядка й стовпця супроводжують їх для зрозумілих людині діагностик.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
start_offset | integer | так | Зміщення в байтах першого байта діапазону в початковому джерелі, відлік від нуля. |
end_offset | integer | так | Зміщення в байтах наступного після останнього байта діапазону в початковому джерелі, тож end_offset мінус start_offset дорівнює довжині діапазону в байтах. |
start_line | integer | так | Номер рядка початку діапазону, відлік від одиниці, для зрозумілих людині діагностик. |
start_column | integer | так | Номер стовпця початку діапазону, відлік від одиниці, для зрозумілих людині діагностик. |
end_line | integer | так | Номер рядка кінця діапазону, відлік від одиниці, для зрозумілих людині діагностик. |
end_column | integer | так | Номер стовпця кінця діапазону, відлік від одиниці, для зрозумілих людині діагностик. |
Додаткові властивості не дозволені.