Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für die gemeinsame Diagnose der Wasm-Plugins

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json

Die eine Diagnoseform, die alle Wasm-Sockets gemeinsam haben. Ein Plugin meldet einen Eintrag pro Problem, das es auslöst; der Host gibt ihn aus. Die Form ist eine Obermenge: Jeder Socket befüllt die Teilmenge, die er verwendet, und lässt den Rest weg, sodass eine Diagnose aus jedem Socket eine einheitliche Struktur ist. severity ist einer von drei Werten, die alle Sockets gemeinsam haben — halt, warn oder info —, sodass eine Diagnose dieselbe Bedeutung trägt, gleich welcher Socket sie ausgelöst hat.

Typ der obersten Ebene: object

Definitionen

Diagnostic

Ein Problem, das ein Diagnose-Emitter ausgelöst hat: ein Schweregrad, eine menschenlesbare Meldung, ein optionaler Ort und optionale Emitter-spezifische Felder. Ein Emitter ist ein Wasm-Plugin-Socket oder der Compiler selbst — beide melden in dieser einen Form, sodass ein Leser einen Eintrag gleich interpretiert, wer auch immer ihn ausgelöst hat. Jeder befüllt die Teilmenge, die er verwendet, und lässt den Rest weg: Ein Parser setzt einen span in location, ein Import setzt code und source_ref, ein Veröffentlichungs-Linter setzt rule_id und classification, ein Governance-Urteil setzt severity und message für das Build-Ergebnis und kann beliebige von code, rule_id, classification, source_ref, location und suggest hinzufügen, und ein Render-Hinweis setzt code, source_ref und eine strukturierte location.

EigenschaftTypErforderlichBeschreibung
severitystring (enum)jaDer Schweregrad der Diagnose, aus einer einzigen geschlossenen Menge, die alle Sockets gemeinsam haben. halt hält den Build an und nennt, was zu beheben ist. warn wird neben einem Build ausgegeben, der dennoch abgeschlossen wird. info hält die Beobachtung fest und lässt das Build-Ergebnis unverändert. Jeder Emitter meldet aus dieser einen Menge, sodass ein Leser einen Schweregrad gleich interpretiert, wer auch immer ihn ausgelöst hat. Zulässige Werte: "halt", "warn", "info"
messagestringjaDer menschenlesbare Diagnosetext.
codestringneinEin optionaler stabiler, maschinell abgleichbarer Code für die Diagnose, unabhängig von der menschenlesbaren Meldung. Fehlt, wenn der Emitter keinen Code vergibt. Ein Code kann von einem Plugin-Socket stammen oder aus den eigenen Hinweisen des Compilers, die bei jedem Eintrag, den sie auslösen, einen setzen.
rule_idstringneinDie Kennung der Regel, die die Diagnose erzeugt hat, wenn der Emitter regelbasiert ist (ein Veröffentlichungs-Linter). Fehlt andernfalls.
classificationstring (enum)neinEine Klassifizierung der Auswirkung auf die semantische Version, die die Diagnose trägt, wenn die auslösende Regel eine vergibt (eine Regel zur Schema-Evolution). Fehlt bei Diagnosen, die keine Klassifizierung tragen. Zulässige Werte: "PATCH", "MINOR", "MAJOR"
source_refstringneinEin opaker Verweis auf das Quellelement, das die Diagnose betrifft (zum Beispiel die Kennung eines Quellknotens, den ein Import nicht auflösen konnte). Fehlt, wenn die Diagnose auf kein bestimmtes Quellelement verweist.
locationLocationneinWohin die Diagnose zeigt, wenn der Emitter das Problem lokalisieren kann. Ein Parser füllt den Byte-Bereich; ein Renderer füllt die strukturierte Position innerhalb eines Quelldokuments. Fehlt, wenn die Diagnose keinen Ort hat.
suggeststringneinEin optionaler Behebungshinweis, den der Emitter neben der Diagnose anbietet. Fehlt, wenn kein Hinweis angeboten wird.

Zusätzliche Eigenschaften sind nicht zulässig.

Location

Wohin eine Diagnose zeigt. Sie trägt einen einzigen vereinheitlichten Lokator, der sowohl einer bytegenauen Position im rohen Quelltext dient (ein Parser füllt span) als auch einer strukturierten Position innerhalb eines Quelldokuments (ein Renderer füllt key_path, uri, line und kind), und nennt die Instanz des Builds, die die Diagnose betrifft, sofern es eine gibt (instance). Jedes Feld ist optional; ein Socket befüllt die Darstellung, die er erzeugen kann, und lässt den Rest weg.

EigenschaftTypErforderlichBeschreibung
spanSpanneinDer Bereich roher Quellbytes, den die Diagnose lokalisiert, wenn der Emitter die Quelle parst und das Problem auf einen Byte-Bereich festlegen kann (ein Parser). Fehlt andernfalls.
key_pathstringneinEin punktierter Pfad zum fehlerhaften Element innerhalb eines strukturierten Quelldokuments, wenn der Emitter das Problem strukturell lokalisiert (ein Renderer). Fehlt andernfalls.
uristringneinEine Kennung für das Quellartefakt, das die Diagnose betrifft, wenn der Emitter sie kennt (ein Renderer). Fehlt andernfalls. Sie nennt nie eine Instanz des Builds; das übernimmt instance.
lineintegerneinEine Zeilennummer innerhalb des strukturierten Quelldokuments, getrennt von der Zeile und Spalte der rohen Bytes, die span trägt. Vorhanden, wenn der Emitter eine Dokumentzeile kennt (ein Renderer). Fehlt andernfalls.
kindstringneinEine offene Zeichenkette, die die Quelloberfläche nennt, auf die sich der Ort bezieht, wenn der Emitter Oberflächen unterscheidet (ein Renderer). Fehlt andernfalls.
instancestringneinDie Instanz des Builds, die die Diagnose betrifft, angegeben durch die Identität, die der Build ihr gibt: eine Komponente durch den Namen, unter dem das Aggregate sie deklariert, eine von einem Modul beigetragene Komponente durch ihren durch das Modul gepunkteten Pfad, eine vom Build abgeleitete Komponente durch die Identität, die der Build für sie zusammensetzt, und ein Modul durch seinen eigenen Pfad. Vorhanden, wenn sich die Diagnose auf eine Instanz bezieht; andernfalls fehlend.

Zusätzliche Eigenschaften sind nicht zulässig.

Span

Ein Bereich der ursprünglichen Quellbytes: Die Byte-Offsets sind der primäre, exakte Ort, und die Zeilen- und Spaltennummern begleiten sie für menschenlesbare Diagnosen.

EigenschaftTypErforderlichBeschreibung
start_offsetintegerjaDer Byte-Offset des ersten Bytes des Bereichs in der ursprünglichen Quelle, nullbasiert.
end_offsetintegerjaDer Byte-Offset eins hinter dem letzten Byte des Bereichs in der ursprünglichen Quelle, sodass end_offset minus start_offset die Länge des Bereichs in Bytes ist.
start_lineintegerjaDie Zeilennummer des Anfangs des Bereichs, einsbasiert, für menschenlesbare Diagnosen.
start_columnintegerjaDie Spaltennummer des Anfangs des Bereichs, einsbasiert, für menschenlesbare Diagnosen.
end_lineintegerjaDie Zeilennummer des Endes des Bereichs, einsbasiert, für menschenlesbare Diagnosen.
end_columnintegerjaDie Spaltennummer des Endes des Bereichs, einsbasiert, für menschenlesbare Diagnosen.

Zusätzliche Eigenschaften sind nicht zulässig.