Salta ai contenuti
AggregaAggrega
Seleziona lingua: Italiano
Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

Schema della diagnostica condivisa dei plugin Wasm di Aggrega

Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.

Id dello schema: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json

L’unica forma di diagnostica che ogni socket Wasm condivide. Un plugin riporta una voce per ogni problema che solleva; l’host la presenta. La forma è un superinsieme: ogni socket popola il sottoinsieme che usa e omette il resto, così una diagnostica proveniente da qualsiasi socket è un’unica struttura uniforme. severity è uno di tre valori che ogni socket condivide — halt, warn o info — così una diagnostica porta lo stesso significato qualunque sia il socket che l’ha sollevata.

Tipo di primo livello: object

Definizioni

Diagnostic

Un problema sollevato da un emettitore di diagnostiche: una gravità, un messaggio leggibile da una persona, una posizione facoltativa e campi facoltativi specifici dell’emettitore. Un emettitore è un socket di plugin Wasm o il compilatore stesso — entrambi riportano su quest’unica forma, così chi legge interpreta una voce allo stesso modo qualunque l’abbia sollevata. Ciascuno popola il sottoinsieme che usa e omette il resto: un parser imposta uno span di location, un’importazione imposta code e source_ref, un linter di pubblicazione imposta rule_id e classification, un verdetto di governance imposta la severity e il message dell’esito della build e può aggiungere uno qualsiasi tra code, rule_id, classification, source_ref, location e suggest, e un avviso di rendering imposta code, source_ref e una location strutturata.

ProprietàTipoObbligatoriaDescrizione
severitystring (enum)sìLa gravità della diagnostica, tratta da un unico insieme chiuso che ogni socket condivide. halt arresta la build e indica che cosa correggere. warn viene presentato accanto a una build che si completa comunque. info registra l’osservazione e lascia invariato l’esito della build. Ogni emettitore riporta a partire da quest’unico insieme, così chi legge interpreta una gravità allo stesso modo qualunque l’abbia sollevata. Valori consentiti: "halt", "warn", "info"
messagestringsìIl testo della diagnostica leggibile da una persona.
codestringnoUn codice facoltativo, stabile e confrontabile da una macchina per la diagnostica, indipendente dal messaggio leggibile da una persona. Assente quando l’emettitore non assegna alcun codice. Un codice può provenire da un socket di plugin o dagli avvisi propri del compilatore, che ne impostano uno su ogni voce che sollevano.
rule_idstringnoL’identificatore della regola che ha prodotto la diagnostica, quando l’emettitore è basato su regole (un linter di pubblicazione). Assente altrimenti.
classificationstring (enum)noUna classificazione dell’impatto sulla versione semantica che la diagnostica porta, quando la regola emittente ne assegna una (una regola di evoluzione dello schema). Assente per le diagnostiche che non portano alcuna classificazione. Valori consentiti: "PATCH", "MINOR", "MAJOR"
source_refstringnoUn riferimento opaco all’elemento del sorgente a cui si riferisce la diagnostica (per esempio l’identificatore di un nodo del sorgente che un’importazione non ha potuto risolvere). Assente quando la diagnostica non fa riferimento ad alcun elemento specifico del sorgente.
locationLocationnoDove punta la diagnostica, quando l’emettitore può localizzare il problema. Un parser compila l’intervallo di byte; un renderer compila la posizione strutturata all’interno di un documento sorgente. Assente quando la diagnostica non ha alcuna posizione.
suggeststringnoUn suggerimento facoltativo di correzione che l’emettitore offre accanto alla diagnostica. Assente quando non viene offerto alcun suggerimento.

Non sono consentite proprietà aggiuntive.

Location

Dove punta una diagnostica. Porta un unico localizzatore unificato che serve sia una posizione precisa al byte nel testo sorgente grezzo (un parser compila span) sia una posizione strutturata all’interno di un documento sorgente (un renderer compila key_path, uri, line e kind), e nomina l’istanza della build a cui si riferisce la diagnostica, quando ce n’è una (instance). Ogni campo è facoltativo; un socket popola la rappresentazione che può produrre e omette il resto.

ProprietàTipoObbligatoriaDescrizione
spanSpannoL’intervallo di byte del sorgente grezzo che la diagnostica localizza, quando l’emettitore analizza il sorgente e può circoscrivere il problema a un intervallo di byte (un parser). Assente altrimenti.
key_pathstringnoUn percorso con notazione a punti verso l’elemento problematico all’interno di un documento sorgente strutturato, quando l’emettitore localizza il problema strutturalmente (un renderer). Assente altrimenti.
uristringnoUn identificatore dell’artefatto sorgente a cui si riferisce la diagnostica, quando l’emettitore lo conosce (un renderer). Assente altrimenti. Non nomina mai un’istanza della build; è instance a indicarla.
lineintegernoUn numero di riga all’interno del documento sorgente strutturato, distinto dalla riga e dalla colonna dei byte grezzi portate da span. Presente quando l’emettitore conosce una riga del documento (un renderer). Assente altrimenti.
kindstringnoUna stringa aperta che nomina la superficie sorgente a cui si riferisce la posizione, quando l’emettitore distingue tra superfici (un renderer). Assente altrimenti.
instancestringnoL’istanza della build a cui si riferisce la diagnostica, indicata con l’identità che la build le dà: un componente con il nome sotto cui l’Aggregate lo dichiara, un componente fornito da un modulo con il suo percorso puntato attraverso il modulo, un componente che la build deriva con l’identità che la build compone per esso, e un modulo con il proprio percorso. Presente quando la diagnostica riguarda una sola istanza; assente altrimenti.

Non sono consentite proprietà aggiuntive.

Span

Un intervallo dei byte del sorgente originale: gli offset in byte sono la posizione primaria ed esatta, e i numeri di riga e di colonna li accompagnano per diagnostiche leggibili da una persona.

ProprietàTipoObbligatoriaDescrizione
start_offsetintegersìL’offset in byte del primo byte dell’intervallo nel sorgente originale, a partire da zero.
end_offsetintegersìL’offset in byte successivo all’ultimo byte dell’intervallo nel sorgente originale, così end_offset meno start_offset è la lunghezza dell’intervallo in byte.
start_lineintegersìIl numero di riga dell’inizio dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona.
start_columnintegersìIl numero di colonna dell’inizio dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona.
end_lineintegersìIl numero di riga della fine dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona.
end_columnintegersìIl numero di colonna della fine dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona.

Non sono consentite proprietà aggiuntive.