Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Wspólny schemat diagnostyki dla wtyczek Wasm w Aggrega

Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.

Identyfikator schematu: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json

Jedyny kształt diagnostyki wspólny dla wszystkich gniazd Wasm. Wtyczka zgłasza jeden wpis na każdy zgłaszany problem; host go udostępnia. Kształt jest nadzbiorem: każde gniazdo wypełnia podzbiór, którego używa, i pomija resztę, więc diagnostyka z dowolnego gniazda ma jedną jednolitą strukturę. severity przyjmuje jedną z trzech wartości wspólnych dla wszystkich gniazd — halt, warn lub info — więc diagnostyka ma to samo znaczenie niezależnie od tego, które gniazdo ją zgłosiło.

Typ najwyższego poziomu: object

Definicje

Diagnostic

Jeden problem zgłoszony przez emiter diagnostyki: poziom ważności, komunikat czytelny dla człowieka, opcjonalna lokalizacja i opcjonalne pola specyficzne dla emitera. Emiterem jest gniazdo wtyczki Wasm albo sam kompilator — oba raportują w tym jednym kształcie, więc czytelnik interpretuje wpis tak samo niezależnie od tego, który go zgłosił. Każdy wypełnia podzbiór, którego używa, i pomija resztę: parser ustawia zakres lokalizacji, import ustawia code i source_ref, linter publikacji ustawia rule_id i classification, werdykt nadzoru ustawia poziom ważności wyniku kompilacji i komunikat oraz może dodać dowolne z pól code, rule_id, classification, source_ref, location i suggest, a ostrzeżenie renderowania ustawia code, source_ref i ustrukturyzowaną lokalizację.

WłaściwośćTypWymaganaOpis
severitystring (enum)takPoziom ważności diagnostyki, wybierany z jednego zamkniętego zbioru wspólnego dla wszystkich gniazd. halt zatrzymuje kompilację i wskazuje, co należy poprawić. warn pojawia się obok kompilacji, która mimo to się kończy. info rejestruje obserwację i nie zmienia wyniku kompilacji. Każdy emiter raportuje z tego jednego zbioru, więc czytelnik interpretuje poziom ważności tak samo niezależnie od tego, kto go zgłosił. Dozwolone wartości: "halt", "warn", "info"
messagestringtakTekst diagnostyki czytelny dla człowieka.
codestringnieOpcjonalny, stabilny kod diagnostyki, nadający się do dopasowania maszynowego, niezależny od komunikatu czytelnego dla człowieka. Nieobecny, gdy emiter nie przypisuje kodu. Kod może pochodzić z gniazda wtyczki albo z własnych ostrzeżeń kompilatora, które ustawiają go w każdym zgłaszanym wpisie.
rule_idstringnieIdentyfikator reguły, która wygenerowała diagnostykę, gdy emiter opiera się na regułach (linter publikacji). W przeciwnym razie nieobecny.
classificationstring (enum)nieKlasyfikacja wpływu na wersję semantyczną, którą niesie diagnostyka, gdy emitująca reguła ją przypisuje (reguła ewolucji schematu). Nieobecna w diagnostykach bez klasyfikacji. Dozwolone wartości: "PATCH", "MINOR", "MAJOR"
source_refstringnieNieprzezroczyste odwołanie do elementu źródłowego, którego dotyczy diagnostyka (na przykład identyfikator węzła źródłowego, którego import nie mógł rozwiązać). Nieobecne, gdy diagnostyka nie odwołuje się do konkretnego elementu źródłowego.
locationLocationnieMiejsce, które wskazuje diagnostyka, gdy emiter potrafi zlokalizować problem. Parser wypełnia zakres bajtów; renderer wypełnia ustrukturyzowaną pozycję w dokumencie źródłowym. Nieobecne, gdy diagnostyka nie ma lokalizacji.
suggeststringnieOpcjonalna wskazówka naprawcza, którą emiter podaje wraz z diagnostyką. Nieobecna, gdy nie podano wskazówki.

Dodatkowe właściwości są niedozwolone.

Location

Miejsce, które wskazuje diagnostyka. Zawiera jeden ujednolicony lokalizator, który obsługuje zarówno pozycję z dokładnością do bajtu w surowym tekście źródłowym (parser wypełnia span), jak i ustrukturyzowaną pozycję w dokumencie źródłowym (renderer wypełnia key_path, uri, line i kind), oraz wskazuje instancję kompilacji, której dotyczy diagnostyka, jeśli taka istnieje (instance). Każde pole jest opcjonalne; gniazdo wypełnia reprezentację, którą potrafi wytworzyć, i pomija resztę.

WłaściwośćTypWymaganaOpis
spanSpannieZakres surowych bajtów źródła, który lokalizuje diagnostyka, gdy emiter parsuje źródło i potrafi przypisać problem do zakresu bajtów (parser). W przeciwnym razie nieobecny.
key_pathstringnieŚcieżka z kropkami do problematycznego elementu w ustrukturyzowanym dokumencie źródłowym, gdy emiter lokalizuje problem strukturalnie (renderer). W przeciwnym razie nieobecna.
uristringnieIdentyfikator artefaktu źródłowego, którego dotyczy diagnostyka, gdy emiter go zna (renderer). W przeciwnym razie nieobecny. Nigdy nie wskazuje instancji kompilacji; to zadanie pola instance.
lineintegernieNumer wiersza w ustrukturyzowanym dokumencie źródłowym, odrębny od wiersza i kolumny surowych bajtów zawartych w span. Obecny, gdy emiter zna wiersz dokumentu (renderer). W przeciwnym razie nieobecny.
kindstringnieOtwarty ciąg znaków nazywający powierzchnię źródła, do której odnosi się lokalizacja, gdy emiter rozróżnia powierzchnie (renderer). W przeciwnym razie nieobecny.
instancestringnieInstancja kompilacji, której dotyczy diagnostyka, wskazana przez tożsamość nadaną jej przez kompilację: komponent przez nazwę, pod którą deklaruje go encja Aggregate, komponent wniesiony przez moduł przez jego ścieżkę z kropkami prowadzącą przez moduł, komponent wyprowadzony przez kompilację przez tożsamość, którą kompilacja dla niego składa, a moduł przez jego własną ścieżkę. Obecna, gdy diagnostyka dotyczy jednej instancji; w przeciwnym razie nieobecna.

Dodatkowe właściwości są niedozwolone.

Span

Zakres oryginalnych bajtów źródła: przesunięcia bajtowe są podstawową, dokładną lokalizacją, a numery wiersza i kolumny towarzyszą im na potrzeby diagnostyki czytelnej dla człowieka.

WłaściwośćTypWymaganaOpis
start_offsetintegertakPrzesunięcie bajtowe pierwszego bajtu zakresu w oryginalnym źródle, liczone od zera.
end_offsetintegertakPrzesunięcie bajtowe o jeden za ostatnim bajtem zakresu w oryginalnym źródle, tak że end_offset minus start_offset to długość zakresu w bajtach.
start_lineintegertakNumer wiersza początku zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka.
start_columnintegertakNumer kolumny początku zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka.
end_lineintegertakNumer wiersza końca zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka.
end_columnintegertakNumer kolumny końca zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka.

Dodatkowe właściwości są niedozwolone.