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

Schema del socket Wasm del linter di Aggrega

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

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

Le forme di trasmissione che il socket del linter consuma (LinterInput) ed emette (LinterOutput). Il linter viene eseguito al momento della pubblicazione su una coppia di entità versione precedente + versione proposta (la regola di evoluzione dello schema) e al momento del controllo delle convenzioni del workspace su singole entità (regole strutturali per regola). Un unico plugin Wasm distribuito ospita molte regole; il plugin seleziona quale regola eseguire tramite LinterInput.rule_id. Questo schema è l’unica fonte di entrambe le forme di trasmissione: i tipi di payload Go, Rust e TypeScript vengono generati da esso nel pacchetto condiviso dell’ABI dei plugin, e ogni kit per plugin riesporta quei tipi generati anziché dichiararne una propria copia.

Una delle forme seguenti

  • LinterInput
  • LinterOutput

Definizioni

LinterInput

Il payload che l’host passa al plugin del linter di pubblicazione a ogni invocazione. rule_id seleziona la regola verso cui il plugin smista. entity_kind identifica il tipo dell’entità sottoposta a lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed porta la struttura analizzata dell’entità che viene classificata (l’host analizza lo YAML in JSON prima dell’invio; il plugin non vede mai byte grezzi). previous porta l’entità analizzata della versione precedente per la regola di evoluzione dello schema; omesso quando non applicabile. implemented_component porta un’entità correlata di un tipo diverso — il Component che una Recipe sottoposta a lint realizza — per le regole che confrontano un’entità con un contratto che un’altra entità dichiara; omesso quando non applicabile. release e components portano il resto di una Release per una regola che ne legge una intera — proposed è allora l’Aggregate che la Release distribuisce, release quella Release, e components il Component di cui ciascuna delle istanze di componente dell’Aggregate è un’istanza; entrambi sono omessi in ogni altro input. policies porta la configurazione della disciplina di pubblicazione per workspace che la regola consulta.

ProprietàTipoObbligatoriaDescrizione
rule_idstringsìLa regola verso cui il plugin deve smistare, nominata tramite il suo id di regola — lo stesso identificatore in kebab-case che il rilievo risultante porta in rule_id, così una regola soppressa o segnalata viene nominata allo stesso modo su ogni superficie. L’insieme riconosciuto è quello che il plugin distribuito smista; un id di regola che il plugin non riconosce produce un rilievo ‘unknown_rule’ anziché un superamento silenzioso.
entity_kindstring (enum)sìIl tipo di entità che i valori proposed/previous codificano. La classificazione della regola di evoluzione dello schema varia a seconda del tipo; le regole strutturali si limitano a tipi specifici. Valori consentiti: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectsìStruttura analizzata dell’entità che viene classificata. L’host converte lo YAML in JSON prima dell’invio, così il plugin riceve un valore già strutturato e non vede mai byte grezzi. Nell’input di una regola che legge un’intera Release è l’Aggregate che quella Release distribuisce. In ogni input ogni valore di parametro viene rimosso prima che l’entità venga consegnata, perché il valore di un parametro può essere la credenziale stessa, così nessun valore di parametro raggiunge un plugin linter tramite questo campo. Un Aggregate mantiene le proprie dichiarazioni spec.parameters, ciascuna con le sole chiavi che lo schema dell’Aggregate ammette su una dichiarazione di parametro diverse da default, e lo stesso vale per ogni dichiarazione annidata sotto properties, items e valuesType: un valore predefinito viene rimosso anziché sostituito, così un plugin non può sapere se una dichiarazione ne fornisce uno, e una chiave che lo schema non ammette in quel punto viene rimossa con tutto ciò che contiene. Il blocco parameters di ciascun modulo sotto spec.aggregates, che porta i valori passati a quel modulo, viene rimosso per intero, così come spec.parameters su un’entità di qualsiasi altro tipo. Il testo dei template che legge un parametro viene mantenuto così come è scritto.
previousobjectnoStruttura analizzata dell’entità della versione precedente, per le regole che eseguono un confronto a coppie (evoluzione dello schema), con i valori dei suoi parametri rimossi esattamente come lo sono da proposed. Omesso quando la regola non ha bisogno di un riferimento alla versione precedente (per esempio alla prima pubblicazione o per regole solo strutturali).
implemented_componentobjectnoStruttura analizzata del Component che una Recipe sottoposta a lint nomina in spec.implements, risolto dall’host. È un’entità correlata di un tipo DIVERSO da quella sottoposta a lint, ed è ciò che la distingue da previous: previous porta un’altra versione della stessa entità, mentre questo campo porta il Component il cui contratto di output dichiarato la Recipe realizza. L’host lo risolve tramite la stessa ricerca nel catalogo che usa una build, basata sul nome del Component, così tutte e tre le forme di vincolo che spec.implements accetta (senza versione, esatta, intervallo compatibile con la major) raggiungono la stessa voce. Omesso quando l’entità sottoposta a lint non è una Recipe, quando non nomina alcun Component o quando nessun Component con quel nome è raggiungibile nelle directory del catalogo del workspace. Un valore assente significa che il confronto non è disponibile, non che il contratto è vuoto: una regola che legge questo campo non emette alcun rilievo quando è assente.
releaseobjectnoStruttura analizzata della Release che un lint con ambito di release nomina, con la sua catena extends incorporata, così una Release figlia porta ciò che eredita dalla sua base. L’host la converte da YAML in JSON come fa per proposed. Il suo blocco spec.parameters contiene i valori che soddisfano i parametri dell’Aggregate, quindi viene rimosso per intero prima che la Release venga consegnata: il valore di un parametro può essere la credenziale stessa, nessuna regola legge il blocco, e così nessun valore di parametro raggiunge un plugin linter tramite questo campo. Presente solo nell’input di una regola che legge un’intera Release, dove proposed è l’Aggregate che questa Release distribuisce, con i valori dei suoi parametri rimossi come descrive proposed; omesso in ogni altro input.
componentsmappa di objectnoIl Component di cui ciascuna istanza di componente dell’Aggregate è un’istanza, indicizzato per il nome di istanza che l’Aggregate le assegna, che è la stessa chiave usata dalle mappe components proprie dell’Aggregate e della Release. Ogni valore è il Component a cui si risolve il tipo dell’istanza, con l’eventuale catena extends incorporata, convertito in JSON come lo è implemented_component. Un’istanza il cui Component non è raggiungibile nelle directory del catalogo del workspace è assente, e una regola legge quell’assenza come non disponibile anziché come un Component che non dichiara nulla. Presente solo accanto a release, nell’input di una regola che legge un’intera Release; omesso in ogni altro input.
source_pathstringnoPercorso del filesystem da cui è stata caricata l’entità. Popolato dai chiamanti host che esplorano il filesystem del catalogo; consumato dalle regole sensibili al percorso (per esempio category-matches-directory). Omesso quando il chiamante non ha un contesto di percorso.
policiesPoliciesnoLa configurazione della disciplina di pubblicazione per workspace che la regola consulta, portata come un oggetto Policies che l’host assembla a partire dalla configurazione del workspace e da eventuali override da riga di comando.

Non sono consentite proprietà aggiuntive.

LinterOutput

La forma della risposta che il plugin del linter di pubblicazione emette. findings porta una voce per ogni invocazione di regola che ha prodotto un risultato. La regola di evoluzione dello schema emette esattamente un rilievo (il verdetto di classificazione); le regole strutturali possono emetterne zero (nessuna violazione) o molti (uno per infrazione).

ProprietàTipoObbligatoriaDescrizione
findingsDiagnostic[]sìRilievi per regola prodotti dall’invocazione del plugin, nell’ordine di emissione del plugin.
errorstringnoUn messaggio di errore impostato quando il guest è stato eseguito ma non ha potuto completare l’operazione; assente in caso di successo. È distinto da qualsiasi diagnostica portata dall’output: le diagnostiche riportano problemi trovati durante un’esecuzione che ha comunque prodotto un risultato, mentre error riporta che l’operazione stessa non è stata completata. L’host presenta un errore presente come un’invocazione del plugin non riuscita.

Non sono consentite proprietà aggiuntive.

Policies

Configurazione della disciplina di pubblicazione per workspace che l’insieme di regole consulta, assemblata dall’host a partire dalle impostazioni della disciplina di pubblicazione della configurazione del workspace e da eventuali override da riga di comando. Questo schema è il contratto per la forma. L’omissione di un campo imposta ciascun flag al valore predefinito false, e l’host scrive solo i campi il cui valore non è quello predefinito.

ProprietàTipoObbligatoriaDescrizione
allow_dynamic_refsbooleananoSe true, l’uso di $dynamicAnchor / $dynamicRef nelle voci di SchemaLibrary è consentito (sopprime la regola dynamic-refs). Valore predefinito: false.
allow_id_overridesbooleananoSe true, gli override di $id nelle voci di SchemaLibrary sono consentiti (sopprime la regola id-overrides). Valore predefinito: false.
allow_direct_x_aggrega_extensionsbooleananoSe true, l’authoring diretto di x-aggrega-selector / x-aggrega-inject è consentito (sopprime la regola x-aggrega-discouragement). Valore predefinito: false.
allow_aggrega_ai_prefixbooleananoSe true, la regola annotation-prefix viene soppressa del tutto (sia il controllo del semplice aggrega.ai/ sia il controllo di feature.aggrega.ai/ condizionato al tipo). Valore predefinito: false.
allow_nonstandard_namesbooleananoSe true, le violazioni della forma del nome sono consentite (sopprime la regola name-shape). Valore predefinito: false.
allow_category_mismatchesbooleananoSe true, sopprime i rilievi della regola category-matches-directory. La convenzione del catalogo standard richiede che i Components sotto core// dichiarino component.aggrega.ai/category={category} corrispondente al segmento della directory, dove {category} è uno dei 15 valori dell’insieme chiuso. I workspace con eccezioni persistenti legittime se ne escludono qui. Valore predefinito: false.
allow_undeclared_recipe_providesbooleananoSe true, sopprime i rilievi della regola provides-declared-by-component. Quella regola segnala ogni chiave che una Recipe pubblica in spec.provides e che il Component nominato dal suo spec.implements non dichiara nel pilastro provides del suo spec.schema. Pubblicare oltre il contratto dichiarato è accettato al momento della build, quindi il rilievo è un avviso; un workspace le cui Recipes pubblicano deliberatamente chiavi che il loro Component non dichiara se ne esclude qui. Valore predefinito: false.
allow_connection_credential_mismatchesbooleananoSe true, sopprime i rilievi della regola connection-credential-matches-target-key. Quella regola legge un’intera Release e confronta, per ogni connessione la cui destinazione dichiara la chiave che richiede ai propri chiamanti, la credenziale che la connessione presenta con la chiave che la destinazione detiene: segnala due estremità che nominano segreti diversi e una chiave dichiarata a una sola estremità. La concordanza tra le due estremità è una convenzione del catalogo anziché qualcosa che una build controlla, quindi il rilievo è un avviso; un workspace le cui due estremità differiscono deliberatamente se ne esclude qui. Valore predefinito: false.

Non sono consentite proprietà aggiuntive.