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

Schema del nucleo di Aggrega (Plugin)

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

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

Un plugin Wasm: un modulo WebAssembly pubblicato in un registry OCI e identificato dal suo metadata.pluginType — il socket che implementa — più il suo semplice metadata.name, che dichiara la versione ABI a cui è destinato, un puntatore di firma opzionale e un blocco runtime opzionale. L’entità e il suo .wasm vengono pubblicati come un unico manifest OCI con il tag metadata.version — lo YAML dell’entità come blob di configurazione del manifest, il .wasm come layer inline, firmati una sola volta. L’identità è la coordinata metadata.pluginType/metadata.name più la metadata.version dell’entità; la posizione del .wasm deriva da quella coordinata più il registry configurato, e il digest del contenuto risolto risiede nel file di lock, non nell’entità. Il file di lock registra il digest, e la policy di fiducia per registry verifica la firma dell’artefatto al momento del pull. Il compilatore non interpreta il comportamento del plugin — instrada il riferimento; il runtime WebAssembly esegue i byte.

Consulta il riferimento per l’authoring del Plugin per una guida in prosa sulla scrittura delle entità Plugin; questa pagina documenta lo schema strutturale descritto da quel riferimento.

Tipo di primo livello: object

Proprietà

ProprietàTipoObbligatoriaDescrizione
apiVersionconst “aggrega.ai/v1beta1”sìCostante: "aggrega.ai/v1beta1"
kindconst “Plugin”sìCostante: "Plugin"
metadataobjectsì
specobjectsìLa versione ABI a cui è destinato il plugin, un puntatore di firma opzionale e un blocco runtime opzionale. La posizione del .wasm del plugin deriva dall’identità del plugin — il suo metadata.pluginType (il socket) più il suo semplice metadata.name — e dal registry configurato; non è riportata nello spec.

Non sono consentite proprietà aggiuntive.

plugin.metadata

ProprietàTipoObbligatoriaDescrizione
namestringsìLungo almeno 1 carattere.
versionstringsìVersionamento semantico rigoroso dell’entità Plugin (ad es. 1.0.0). Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
pluginTypestring (enum)sìIl tipo di socket che questo plugin implementa. Un plugin implementa esattamente un tipo di socket, scelto dalla tassonomia dei tipi di plugin che il runtime riconosce: provider (renderizza i nodi IR in artefatti nativi del provider), linter (ispeziona il contenuto scritto dagli autori e solleva diagnostiche), pipeline-step (un passo nella pipeline: di una FeatureRecipe o di una Recipe che applica patch all’insieme dei documenti renderizzati), governance (serve i ruoli di governance della pipeline di build — trasformando le etichette dei nodi alla costruzione della topologia, oppure emettendo un verdetto di accettazione/rifiuto sul grafo IR durante l’analisi statica o sugli artefatti renderizzati durante il rendering; è il ruolo a cui è associato, non il suo tipo, a stabilire che cosa può emettere), cli (aggiunge un sottocomando runtime aggrega <cmd> che un operatore invoca dalla riga di comando — un socket di runtime, distinto dai socket di rendering e di pipeline in fase di compilazione), parser (trasforma un testo sorgente esterno in un albero strutturato canonico, così che un consumatore legga l’albero senza dover portare con sé un proprio parser del linguaggio, e dichiara i formati che gestisce come capacità parse:<format>), importer (trasforma una sorgente esterna di infrastruttura o di definizione di agenti in file di authoring Aggrega in bozza, e dichiara i formati che gestisce come capacità import:<format>). Valori consentiti: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
descriptionstringnoChe cos’è questa entità e a che cosa serve, scritto per chi sta decidendo se usarla. Apri con una frase che nomina la cosa, poi aggiungi ciò di cui un lettore ha bisogno per sceglierla e usarla correttamente — che cosa si aspetta dalla build che la esegue, e qualsiasi aspetto sorprendente del suo comportamento. Un breve paragrafo è la lunghezza abituale.
maintainersobject[]noElenco dei manutentori responsabili di questa entità.
licensestringnoIdentificatore SPDX della licenza del software descritto da questa entità, come MIT o AGPL-3.0. Registra le condizioni di quel software, non le condizioni di questo file.
repositorystringnoL’URL del repository Git in cui risiedono i file sorgente.
homestringnoL’URL della home page, del wiki o della documentazione di questa entità.
keywordsstring[]noUn elenco di parole chiave descrittive per la reperibilità nell’interfaccia utente.

Non sono consentite proprietà aggiuntive.

plugin.metadata.maintainers[]
ProprietàTipoObbligatoriaDescrizione
namestringsì
emailstringno
urlstringno

Non sono consentite proprietà aggiuntive.

plugin.spec

La versione ABI a cui è destinato il plugin, un puntatore di firma opzionale e un blocco runtime opzionale. La posizione del .wasm del plugin deriva dall’identità del plugin — il suo metadata.pluginType (il socket) più il suo semplice metadata.name — e dal registry configurato; non è riportata nello spec.

ProprietàTipoObbligatoriaDescrizione
abiVersionstring (enum)sìLa versione ABI host/guest a cui è destinato il plugin. v1beta1 è l’unico valore accettato; un Plugin che dichiara una versione ABI che questo compilatore non parla più viene rifiutato, indicando la versione rispetto a cui ricompilare il plugin. Valori consentiti: "v1beta1"
signatureobjectnoUn puntatore descrittivo opzionale alla firma allegata del plugin. Questo blocco è solo documentazione — registra, per chi legge il catalogo, dove si trova la firma e come è stata prodotta; di per sé non blocca né ammette il plugin. Il controllo che lo fa valere è la policy di fiducia per registry applicata al pull: una firma viene scaricata come referrer OCI, verificata rispetto alle identità attendibili o alla chiave fissata del registry, e registrata come fatto verificato nel file di lock. Un registry che richiede le firme arresta il pull quando una firma richiesta è mancante, non attendibile o non valida.
runtimeobjectnoVincoli di esecuzione opzionali che l’host applica quando carica ed esegue il plugin. L’accesso alla rete in uscita non è un campo di authoring: un plugin non raggiunge mai la rete in fase di build (il limite ahead-of-time), quindi qui non c’è alcun campo di allowlist degli host da scrivere.
exportsobject[]noLe esportazioni che questo plugin offre, ciascuna con la propria capacità dichiarata. Un’esportazione è un punto di ingresso con nome a cui l’host smista le chiamate (per esempio render_node, lint_naming, step); il blocco di capacità per esportazione è la dichiarazione scritta dall’autore di ciò che quell’esportazione fa, che l’host verifica rispetto all’autodichiarazione del plugin alla pubblicazione e al caricamento. Le voci preservano l’ordine dell’autore. Se assente, non dichiara alcuna superficie di esportazione scritta dall’autore.
commandsobject[]noGestito dalla macchina, da non scrivere a mano: registrato da aggrega plugin sync (o aggrega plugin gen-catalog) a partire dall’autodichiarazione del plugin. I verbi di primo livello aggrega <command> che un plugin CLI aggiunge vengono letti dall’autodichiarazione del plugin e registrati qui nell’ordine in cui l’autodichiarazione li dichiara, così la superficie di comandi con cui si installa un plugin CLI è leggibile dall’entità senza caricare il plugin. Un plugin non CLI non aggiunge comandi e registra un elenco vuoto. L’host installa esattamente questo insieme; un insieme registrato che diverge dall’autodichiarazione del plugin provoca un arresto al caricamento, e la pubblicazione rifiuta un insieme non sincronizzato con il binario e indica all’autore di registrarlo di nuovo.
providerobjectnoIl blocco del socket provider per un plugin pluginType: provider: le capacità che serve, come traduce il tipo Workload aggrega.ai/v1beta1, quali annotazioni native della piattaforma legge e il suo contratto di comportamento di rendering. Presente solo sui plugin che eseguono il rendering come provider; assente su ogni altro tipo di plugin.
pipelineStepobjectnoIl blocco pipeline-step per un plugin pluginType: pipeline-step: le capacità del provider con cui il suo passo è compatibile. Presente solo sui plugin pipeline-step; assente su ogni altro tipo di plugin.
parserobjectnoIl blocco parser per un plugin pluginType: parser: i formati sorgente che trasforma in un albero strutturato canonico. Presente solo sui plugin parser; assente su ogni altro tipo di plugin.
importerobjectnoIl blocco importer per un plugin pluginType: importer: i formati sorgente esterni che trasforma in file di authoring Aggrega in bozza, e le firme da cui si riconosce una sorgente in quei formati. Presente solo sui plugin importer; assente su ogni altro tipo di plugin.

Non sono consentite proprietà aggiuntive.

plugin.spec.signature

Un puntatore descrittivo opzionale alla firma allegata del plugin. Questo blocco è solo documentazione — registra, per chi legge il catalogo, dove si trova la firma e come è stata prodotta; di per sé non blocca né ammette il plugin. Il controllo che lo fa valere è la policy di fiducia per registry applicata al pull: una firma viene scaricata come referrer OCI, verificata rispetto alle identità attendibili o alla chiave fissata del registry, e registrata come fatto verificato nel file di lock. Un registry che richiede le firme arresta il pull quando una firma richiesta è mancante, non attendibile o non valida.

ProprietàTipoObbligatoriaDescrizione
typeconst “sigstore-cosign”sìLo schema di firma. sigstore-cosign è lo schema supportato. Costante: "sigstore-cosign"
signatureRefstringnoIl riferimento referrer OCI del bundle di firma allegato, a scopo di documentazione e scoperta. Assente quando la firma viene individuata tramite l’enumerazione dei referrer al pull anziché essere fissata qui.
publicKeyRefstringnoUn puntatore alla chiave pubblica con cui è stata prodotta la firma, per una firma con chiave. L’assenza indica una firma keyless (basata sull’identità OIDC), verificata rispetto alle identità attendibili del registry.

Non sono consentite proprietà aggiuntive.

plugin.spec.runtime

Vincoli di esecuzione opzionali che l’host applica quando carica ed esegue il plugin. L’accesso alla rete in uscita non è un campo di authoring: un plugin non raggiunge mai la rete in fase di build (il limite ahead-of-time), quindi qui non c’è alcun campo di allowlist degli host da scrivere.

ProprietàTipoObbligatoriaDescrizione
maxMemoryPagesintegernoLimita la memoria lineare del plugin in pagine Wasm (64 KiB per pagina). Zero o l’assenza applicano il limite predefinito della piattaforma, così un caricamento non è mai illimitato; un’associazione che ha bisogno di più memoria aumenta questo valore. Minimo: 0.
timeoutMsintegernoLimita per quanto tempo il codice proprio del plugin può essere eseguito durante una chiamata, in millisecondi, senza contare il tempo trascorso all’interno delle funzioni host che chiama. Su Linux la misura è il tempo di processore, quindi il tempo trascorso ad attendere un processore su una macchina carica non conta; su altri sistemi è il tempo reale trascorso. La prima chiamata a un plugin appena caricato conta anche l’avvio proprio del plugin. Zero o l’assenza applicano il limite predefinito della piattaforma, così una chiamata non è mai impossibile da annullare; un’associazione che viene eseguita più a lungo aumenta questo valore. Minimo: 0.
hostFunctionsstring[]noGestito dalla macchina, da non scrivere a mano: le funzioni host che il plugin importa, lette dalla sezione import del .wasm da aggrega plugin sync (o aggrega plugin gen-catalog) e registrate qui in forma canonica (ordinata, senza duplicati). La pubblicazione le ricava di nuovo dal binario e rifiuta un’entità il cui record differisce; il pull le ricava e le verifica di nuovo. L’host registra esattamente questo insieme derivato e convalida ogni voce rispetto alla allowlist curata.
configKVmappa di stringnoConfigurazione specifica del Plugin che il runtime passa al plugin all’avvio, come coppie chiave/valore da stringa a stringa. Le voci preservano l’ordine dell’autore, così il record emesso è identico byte per byte tra un’esecuzione e l’altra. L’assenza lascia in vigore la configurazione vuota predefinita del runtime.

Non sono consentite proprietà aggiuntive.

plugin.spec.exports[]
ProprietàTipoObbligatoriaDescrizione
namestringsìIl nome ABI dell’esportazione — il nome a cui l’host smista le chiamate (per esempio render_node, lint_naming, step). Almeno 1 carattere.
operatesstring (enum)noL’operazione di pipeline che questa esportazione esegue: patch (modifica un documento renderizzato esistente) o emit (aggiunge un nuovo documento). Se assente, non porta alcuna dichiarazione sull’operazione. Valori consentiti: "patch", "emit"
scopestring (enum)noLa radice di documenti su cui opera questa esportazione: own (i documenti renderizzati propri del nodo) o host (i documenti del componente a cui è associata una FeatureRecipe con ambito componente). Se assente, non porta alcuna dichiarazione sull’ambito. Valori consentiti: "own", "host"
selectorstringnoUna descrizione libera e leggibile da una persona di ciò su cui agisce l’esportazione (per esempio workloads carrying a pod template). Documentazione per chi legge il catalogo; il compilatore non la interpreta.

Non sono consentite proprietà aggiuntive.

plugin.spec.commands[]
ProprietàTipoObbligatoriaDescrizione
namestringsìIl verbo di comando che l’host registra — il token aggrega <name> che un operatore invoca, e il discriminante che l’host passa al plugin all’invocazione, così un unico plugin che sostiene più comandi instrada in base al comando che è stato chiamato. Almeno 1 carattere.
descriptionstringnoIl testo di aiuto breve, su una riga, del comando, mostrato nell’elenco dei comandi e nell’output dell’aiuto. Solo documentazione; l’host non agisce in base a esso.
flagsobject[]noI flag del comando, nell’ordine dichiarato. Ogni voce aggiunge un flag che l’host registra sul comando, così aggrega help lo mostra come il flag di un comando integrato. Un comando senza flag lascia l’elenco vuoto. All’interno di un comando ogni nome di flag e ogni forma abbreviata compare una sola volta, e nessuno riusa un flag che ogni comando aggrega ha già — --help, -h e i flag globali; l’host lo verifica quando aggiunge i comandi del plugin, e un plugin le cui dichiarazioni non superano la verifica non viene aggiunto, con un avvertimento.

Non sono consentite proprietà aggiuntive.

plugin.spec.commands[].flags[]
ProprietàTipoObbligatoriaDescrizione
namestringsìIl nome lungo del flag — il token —name che un operatore passa sulla riga di comando. Ogni flag dichiarato deve indicarlo. Almeno 1 carattere.
shorthandstringnoL’alias breve opzionale del flag — la forma -x che un operatore può passare al posto del nome lungo — come singola lettera o cifra ASCII. L’assenza significa che il flag non ha alias breve. Pattern: ^[A-Za-z0-9]$.
descriptionstringnoIl testo di aiuto di una riga del flag, mostrato nell’output di aiuto del comando. È documentazione opzionale; l’host non lo convalida né agisce su di esso.
typestring (enum)noIl tipo di valore del flag — string, bool o int — e il tipo di flag con cui l’aiuto lo presenta. Se assente, viene presentato come flag di tipo stringa. Valori consentiti: "string", "bool", "int"
defaultstringnoIl valore predefinito del flag quando l’operatore non lo passa, espresso come stringa. Per un flag bool o int è un valore di quel tipo. Se assente, il flag non dichiara alcun valore predefinito.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider

Il blocco del socket provider per un plugin pluginType: provider: le capacità che serve, come traduce il tipo Workload aggrega.ai/v1beta1, quali annotazioni native della piattaforma legge e il suo contratto di comportamento di rendering. Presente solo sui plugin che eseguono il rendering come provider; assente su ogni altro tipo di plugin.

ProprietàTipoObbligatoriaDescrizione
capabilitiesstring[]noRegistrato a partire dall’autodichiarazione del .wasm del plugin da aggrega plugin gen-catalog, così è il plugin la fonte di questo elenco. Un autore può restringerlo prima della pubblicazione, rimuovendo una voce che questa entità non deve offrire, e non può aggiungerne nessuna che l’autodichiarazione non nomini: la pubblicazione, e aggrega validate a cui viene fornito il .wasm del plugin con --plugin, rifiutano un elenco che nomina una capacità che l’autodichiarazione non nomina. La pubblicazione invia l’entità così come è scritta, senza mai riscrivere questo elenco, e segnala ogni capacità nominata dall’autodichiarazione che l’elenco tralascia. Le capacità servite da questo provider — nomi di capacità come helm o compose — di cui renderizza la forma dell’output. Un provider è generico tra gli artefatti che condividono la forma dell’output di una capacità, non tra tutte le capacità, quindi l’elenco è una dichiarazione esplicita di compatibilità verificata e non un’aspirazione. Le voci preservano l’ordine dell’autore. La destinazione di provider richiesta da una Recipe si risolve nel plugin provider il cui elenco contiene quella destinazione; una destinazione elencata da più di un plugin provider provoca un arresto per ambiguità, a meno che la selezione plugins.providers della configurazione del workspace non indichi quale plugin usare. Un elenco vuoto o assente non dichiara alcuna capacità, quindi il plugin non serve alcuna destinazione.
workloadSchemastringnoJSON Schema 2020-12 che documenta come questo provider traduce il tipo Workload aggrega.ai/v1beta1 in manifest nativi del provider. Quando è presente, il provider supporta le Recipes che dichiarano un blocco workload: (modalità sintetizzata) — il provider traduce il Workload in manifest nativi del provider, guidato da questo schema come documentazione/contratto. Se una Recipe con workload: è supportata è determinato dalla capacità di sintesi del provider legato, non dalla presenza di questo campo: una Recipe in modalità sintetizzata legata a un provider che non può eseguire la sintesi provoca un arresto esplicito in fase di rendering. Il catalogo della libreria standard dichiara workloadSchema sui provider che eseguono la sintesi come contratto documentato, mantenuto allineato con quella capacità. Il campo è il contratto documentato: il corpo viene compilato in JSON Schema 2020-12 al caricamento per verificare che sia ben formato, e nient’altro lo legge.
wellKnownAnnotationsobject[]noLa dichiarazione di supporto del provider: le chiavi di annotazione ben note native della piattaforma (il namespace aggrega.ai/) che questo provider legge, ciascuna con l’ambito in cui viene letta e il comportamento applicato quando è assente. Dichiara una chiave solo dove il provider la legge — la matrice di supporto pubblicata viene renderizzata da queste dichiarazioni, quindi una chiave elencata qui è una chiave di cui un autore può aspettarsi che modifichi l’output renderizzato nell’ambito che indica. Il compilatore legge la dichiarazione in due modi: uno scope che nomina un tipo di input che il contract.inputKinds del provider stesso non dichiara contraddice una dichiarazione adiacente nella stessa entità, e la build si arresta nominando la chiave e la contraddizione; e una build avvisa di un’annotazione aggrega.ai/ che raggiunge un rendering attraverso questo provider quando nessuna voce la copre su alcun tipo di input dichiarato da quel rendering. È distinta dalla regola che governa il legame di un valore sotto il prefisso riservato aggrega.ai/. Se assente, non dichiara alcun supporto, e per questo provider non viene sollevato alcun avviso di questo tipo; un provider che non legge nessuna di queste chiavi dichiara readsNoWellKnownAnnotations al posto di questo elenco. Le voci sono un elenco ordinato e preservano l’ordine dell’autore.
readsNoWellKnownAnnotationsconst truenoDichiara che questo provider non legge nessuna delle chiavi di annotazione native della piattaforma nel namespace aggrega.ai/, le chiavi che wellKnownAnnotations altrimenti elencherebbe: una dichiarazione di supporto che non copre alcuna chiave, che è un’affermazione laddove omettere sia questo campo sia wellKnownAnnotations è silenzio. Una build avvisa allora di ogni annotazione aggrega.ai/ che raggiunge un rendering attraverso questo provider, nominando la chiave, il provider e i tipi di input dichiarati da quel rendering; il valore passa comunque intatto e la build non si arresta. Si può scrivere solo true, così omettere il campo resta l’unico modo per non dire nulla. Non può essere scritto insieme a wellKnownAnnotations: un provider che legge alcune delle chiavi elenca invece quelle lì. Costante: true
contractobjectnoIl contratto di comportamento di rendering autodichiarato dal provider: i tipi di input che renderizza, come assembla l’output per nodo di un gruppo di smistamento e sotto quali directory si trova quell’output, la coppia di delimitatori di template che applica ai file di artefatti importati, se un’unica istanza caricata può servire ogni attraversamento, se collega archi tra confini, se rispetta le voci di esclusione, se accetta i file che una Recipe contribuisce all’output condiviso del suo confine, e quali file il suo ecosistema non include mai accanto a una sorgente. È il record, al momento della pubblicazione, dell’autodichiarazione del plugin provider, che l’host verifica rispetto a quella stessa autodichiarazione alla pubblicazione e al caricamento. Se assente, non dichiara alcun contratto di comportamento di rendering, e la verifica incrociata confronta solo le dichiarazioni per esportazione.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.wellKnownAnnotations[]
ProprietàTipoObbligatoriaDescrizione
keystringsìLa chiave di annotazione ben nota nativa della piattaforma che il provider legge (ad es. aggrega.ai/namespace). Si trova sotto il namespace di annotazioni aggrega.ai/ riservato alla piattaforma — le direttive di piattaforma lette dal provider. Pattern: ^aggrega\.ai/.+.
purposestringsìCiò che l’annotazione controlla — il comportamento di rendering che influenza quando è presente.
defaultBehaviorstringnoIl comportamento che il provider applica quando questa annotazione è assente.
scopestring (enum)[]noDove questo provider legge la chiave. I primi tre valori sono i tipi di input della Recipe e nominano il percorso di rendering su cui la chiave viene letta — sourced un insieme di file vendorizzati, synthesized un Workload che il provider materializza, artifactsStandalone un nodo il cui intero output è costituito da documenti di artefatti importati. Ognuno di essi deve essere un tipo di input dichiarato dal contract.inputKinds di questo provider; nominarne uno che non dichiara arresta la build. boundary è per una chiave risolta una volta per confine anziché per nodo — il nome di un artefatto assemblato, o il contesto di posizionamento da cui viene formato un riferimento tra confini — dove il tipo di input non è un asse significativo, quindi non viene confrontato con contract.inputKinds. Una chiave letta su più di un percorso li elenca tutti. Se assente, non fa alcuna dichiarazione per percorso: non viene verificato nulla, e la chiave afferma solo che il provider la legge da qualche parte. Almeno 1 voce. Nessuna voce può comparire due volte. Valori consentiti per ogni voce: "sourced", "synthesized", "artifactsStandalone", "boundary".

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.contract

Il contratto di comportamento di rendering autodichiarato dal provider: i tipi di input che renderizza, come assembla l’output per nodo di un gruppo di smistamento e sotto quali directory si trova quell’output, la coppia di delimitatori di template che applica ai file di artefatti importati, se un’unica istanza caricata può servire ogni attraversamento, se collega archi tra confini, se rispetta le voci di esclusione, se accetta i file che una Recipe contribuisce all’output condiviso del suo confine, e quali file il suo ecosistema non include mai accanto a una sorgente. È il record, al momento della pubblicazione, dell’autodichiarazione del plugin provider, che l’host verifica rispetto a quella stessa autodichiarazione alla pubblicazione e al caricamento. Se assente, non dichiara alcun contratto di comportamento di rendering, e la verifica incrociata confronta solo le dichiarazioni per esportazione.

ProprietàTipoObbligatoriaDescrizione
inputKindsobjectnoQuale dei tre tipi di input della Recipe questo plugin renderizza: un insieme di file con sorgente, un carico di lavoro sintetizzato e un nodo autonomo di soli artefatti. Ogni campo è una dichiarazione indipendente.
boundaryAssemblystring (enum)noCome il plugin combina l’output di rendering per nodo di un gruppo di smistamento: none scrive l’output di ciascun nodo direttamente nel percorso di smistamento; merge fonde i frammenti per nodo in un unico documento; nest colloca l’output di ciascun nodo nella propria posizione all’interno di una struttura ombrello. Se assente, non porta alcuna dichiarazione sull’assemblaggio. Valori consentiti: "none", "merge", "nest"
artifactDelimitersobjectnoLa coppia di delimitatori dei template Go che il plugin applica ai file di artefatti importati. Se assente, vale la coppia predefinita {{/}}; un plugin la cui sintassi di destinazione entra in conflitto con quella coppia dichiara qui una coppia alternativa.
assemblyNameAnnotationobjectnoL’annotazione di confine il cui valore risolto nomina l’artefatto che il plugin assembla da un gruppo di smistamento. Un plugin che riunisce in un unico assemblaggio con nome i confini che contribuiscono a un gruppo dichiara la chiave di annotazione che legge e se ogni confine che contribuisce deve concordare sul valore risolto di quell’annotazione. Se assente, il plugin dà un nome al proprio assemblaggio a partire dal solo percorso di smistamento.
reusableInstancebooleananoSe un’unica istanza caricata del plugin può servire ogni attraversamento di rendering, di assemblaggio e di validazione di una build anziché un’istanza nuova per ogni attraversamento. Va dichiarato true solo quando il plugin non mantiene alcuno stato tra un attraversamento e l’altro — una funzione pura del suo input per attraversamento — così che un’unica istanza produca un output identico byte per byte, che venga riutilizzata o caricata da capo. Se assente (false), viene caricata un’istanza nuova per ogni attraversamento, isolando per costruzione un plugin che porta uno stato.
crossBoundaryLinkingbooleananoSe il plugin collega un arco uses tra confini — un arco uses le cui estremità consumatrice e consumata vengono assemblate in gruppi di smistamento diversi — emettendo un cablaggio di riferimenti incrociati nativo del provider tramite un contratto di esportazione accoppiato link_publish/link_resolve. Va dichiarato true solo quando il plugin esporta entrambi; una dichiarazione che non corrisponde alla coppia di esportazioni provoca un arresto al caricamento. Se assente (false), non dichiara alcun collegamento tra confini, quindi l’host non instrada al plugin alcun attraversamento di collegamento.
omitsbooleananoSe il provider rispetta le voci di esclusione — voci che nominano unità renderizzate da escludere dall’output di un nodo: esclude da ciò che renderizza ogni unità a cui una voce corrisponde, e riporta a quante unità ha corrisposto ciascuna voce. È il record, al momento della pubblicazione, della dichiarazione omits contenuta nell’autodichiarazione del provider, e un valore che differisce da quella autodichiarazione provoca un arresto al caricamento. Se assente (false), non dichiara tale supporto.
boundaryArtifactsbooleananoSe il provider accetta i file che una Recipe contribuisce all’output condiviso del confine in cui viene renderizzata, sotto spec.boundary.artifacts della Recipe: il compilatore scrive ciascuno di tali file una sola volta, nella directory che contiene l’output assemblato del confine, e la destinazione del provider lo tratta come parte di quell’output. È il record, al momento della pubblicazione, della dichiarazione boundary_artifacts contenuta nell’autodichiarazione del provider, e un valore che differisce da quella autodichiarazione provoca un arresto al caricamento. Se assente (false), non dichiara tale supporto, e una Recipe che dichiara il blocco per questo provider viene rifiutata prima che venga renderizzato qualsiasi cosa.
nestSegmentstringnoLa directory sotto cui la destinazione di questo provider colloca la sottodirectory propria di ciascun contributore, per un provider il cui boundaryAssembly è nest — charts per un chart ombrello, modules per un modulo radice. Il compilatore unisce questa directory, il nome del contributore e il percorso proprio di ciascun file. Viene letta solo per un provider che annida. Se assente, la sottodirectory di ciascun contributore viene collocata direttamente nella directory propria del confine. Il valore nomina una sola directory e mai un percorso.
sourceIgnoreobjectnoI file che l’ecosistema di questo provider non include mai accanto a una sorgente che renderizza, espressi come regole ignore in sintassi gitignore — il record, al momento della pubblicazione, delle regole source_ignore che la sua autodichiarazione dichiara. Quando un autore fissa una Recipe o una FeatureRecipe la cui capacità questo provider serve per lui, queste regole vengono composte con il .aggregaignore proprio dell’autore e registrate nell’entity.lock accanto all’entità, insieme al nome di questo plugin, e ogni successiva pubblicazione, confronto e rendering della sorgente locale dell’entità applica le regole registrate. Dove presente, deve essere uguale a ciò che dichiara l’autodichiarazione, e il caricamento rifiuta un plugin la cui autodichiarazione differisce; se assente, non fa alcuna dichiarazione e non viene confrontato.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.contract.inputKinds

Quale dei tre tipi di input della Recipe questo plugin renderizza: un insieme di file con sorgente, un carico di lavoro sintetizzato e un nodo autonomo di soli artefatti. Ogni campo è una dichiarazione indipendente.

ProprietàTipoObbligatoriaDescrizione
sourcedbooleananoRenderizza un insieme di file con sorgente (un chart, un modulo, un file compose).
synthesizedbooleananoRenderizza un carico di lavoro sintetizzato in artefatti nativi del provider.
artifactsStandalonebooleananoRenderizza un nodo autonomo di soli artefatti — uno che porta documenti di artefatti importati e nessuna sorgente né carico di lavoro.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.contract.artifactDelimiters

La coppia di delimitatori dei template Go che il plugin applica ai file di artefatti importati. Se assente, vale la coppia predefinita {{/}}; un plugin la cui sintassi di destinazione entra in conflitto con quella coppia dichiara qui una coppia alternativa.

ProprietàTipoObbligatoriaDescrizione
leftstringsìIl delimitatore di apertura.
rightstringsìIl delimitatore di chiusura.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.contract.assemblyNameAnnotation

L’annotazione di confine il cui valore risolto nomina l’artefatto che il plugin assembla da un gruppo di smistamento. Un plugin che riunisce in un unico assemblaggio con nome i confini che contribuiscono a un gruppo dichiara la chiave di annotazione che legge e se ogni confine che contribuisce deve concordare sul valore risolto di quell’annotazione. Se assente, il plugin dà un nome al proprio assemblaggio a partire dal solo percorso di smistamento.

ProprietàTipoObbligatoriaDescrizione
annotationstringsìLa chiave dell’annotazione di confine da cui il plugin legge il nome dell’artefatto assemblato.
requireUniquebooleananoSe ogni confine che contribuisce a un unico gruppo di smistamento deve concordare sul valore risolto dell’annotazione. Quando è true, un gruppo i cui confini che contribuiscono risolvono l’annotazione in valori diversi arresta la build; quando è false, il plugin accetta il primo valore risolto.

Non sono consentite proprietà aggiuntive.

plugin.spec.provider.contract.sourceIgnore

I file che l’ecosistema di questo provider non include mai accanto a una sorgente che renderizza, espressi come regole ignore in sintassi gitignore — il record, al momento della pubblicazione, delle regole source_ignore che la sua autodichiarazione dichiara. Quando un autore fissa una Recipe o una FeatureRecipe la cui capacità questo provider serve per lui, queste regole vengono composte con il .aggregaignore proprio dell’autore e registrate nell’entity.lock accanto all’entità, insieme al nome di questo plugin, e ogni successiva pubblicazione, confronto e rendering della sorgente locale dell’entità applica le regole registrate. Dove presente, deve essere uguale a ciò che dichiara l’autodichiarazione, e il caricamento rifiuta un plugin la cui autodichiarazione differisce; se assente, non fa alcuna dichiarazione e non viene confrontato.

ProprietàTipoObbligatoriaDescrizione
patternsstring[]noI pattern ignore propri dell’ecosistema, ciascuno con ambito alla radice della directory della sorgente locale, nell’ordine in cui si applicano.
filesstring[]noI nomi dei file ignore che l’ecosistema rispetta all’interno di una sorgente — .helmignore per un chart. Le righe di ciascuno di tali file sono ulteriori pattern, con ambito alla directory che lo contiene.

Non sono consentite proprietà aggiuntive.

plugin.spec.pipelineStep

Il blocco pipeline-step per un plugin pluginType: pipeline-step: le capacità del provider con cui il suo passo è compatibile. Presente solo sui plugin pipeline-step; assente su ogni altro tipo di plugin.

ProprietàTipoObbligatoriaDescrizione
capabilitiesstring[]noRegistrato a partire dall’autodichiarazione del .wasm del plugin da aggrega plugin gen-catalog, così è il plugin la fonte di questo elenco. Un autore può restringerlo prima della pubblicazione, rimuovendo una voce che questa entità non deve offrire, e non può aggiungerne nessuna che l’autodichiarazione non nomini: la pubblicazione, e aggrega validate a cui viene fornito il .wasm del plugin con --plugin, rifiutano un elenco che nomina una capacità che l’autodichiarazione non nomina. La pubblicazione invia l’entità così come è scritta, senza mai riscrivere questo elenco, e segnala ogni capacità nominata dall’autodichiarazione che l’elenco tralascia. Le capacità del provider con cui il passo di pipeline di questo plugin è compatibile — i nomi di capacità del provider, come helm o compose, il cui output renderizzato il passo sa trasformare. Un passo è scritto rispetto alla forma dell’output di un solo provider alla volta, quindi l’elenco è una dichiarazione esplicita di compatibilità verificata e non un’aspirazione. Le voci preservano l’ordine dell’autore. È il record leggibile dal catalogo di quella dichiarazione; la build legge la stessa dichiarazione dal plugin quando un passo tocca un ambito e si arresta quando il provider che renderizza i documenti di quell’ambito non è tra essi. Un elenco vuoto o assente non dichiara alcuna compatibilità, quindi nessun ambito ammette il passo.

Non sono consentite proprietà aggiuntive.

plugin.spec.parser

Il blocco parser per un plugin pluginType: parser: i formati sorgente che trasforma in un albero strutturato canonico. Presente solo sui plugin parser; assente su ogni altro tipo di plugin.

ProprietàTipoObbligatoriaDescrizione
capabilitiesstring[]noRegistrato a partire dall’autodichiarazione del .wasm del plugin da aggrega plugin gen-catalog, così è il plugin la fonte di questo elenco. Un autore può restringerlo prima della pubblicazione, rimuovendo una voce che questa entità non deve offrire, e non può aggiungerne nessuna che l’autodichiarazione non nomini: la pubblicazione, e aggrega validate a cui viene fornito il .wasm del plugin con --plugin, rifiutano un elenco che nomina una capacità che l’autodichiarazione non nomina. La pubblicazione invia l’entità così come è scritta, senza mai riscrivere questo elenco, e segnala ogni capacità nominata dall’autodichiarazione che l’elenco tralascia. I formati sorgente che questo parser trasforma in un albero strutturato canonico, ciascuno scritto come parse:<format> — ad esempio parse:yaml. Il prefisso fa parte della voce, quindi un plugin che annuncia più formati elenca una voce per formato. Le voci preservano l’ordine dell’autore. Un formato richiesto si risolve nel parser il cui elenco contiene la voce corrispondente; un formato che nessun parser annuncia arresta la build, e un formato annunciato da più di un plugin parser provoca un arresto per ambiguità. Un elenco vuoto o assente non dichiara alcun formato, quindi il plugin non analizza nulla.

Non sono consentite proprietà aggiuntive.

plugin.spec.importer

Il blocco importer per un plugin pluginType: importer: i formati sorgente esterni che trasforma in file di authoring Aggrega in bozza, e le firme da cui si riconosce una sorgente in quei formati. Presente solo sui plugin importer; assente su ogni altro tipo di plugin.

ProprietàTipoObbligatoriaDescrizione
capabilitiesstring[]noRegistrato a partire dall’autodichiarazione del .wasm del plugin da aggrega plugin gen-catalog, così è il plugin la fonte di questo elenco. Un autore può restringerlo prima della pubblicazione, rimuovendo una voce che questa entità non deve offrire, e non può aggiungerne nessuna che l’autodichiarazione non nomini: la pubblicazione, e aggrega validate a cui viene fornito il .wasm del plugin con --plugin, rifiutano un elenco che nomina una capacità che l’autodichiarazione non nomina. La pubblicazione invia l’entità così come è scritta, senza mai riscrivere questo elenco, e segnala ogni capacità nominata dall’autodichiarazione che l’elenco tralascia. I formati sorgente esterni che questo importer trasforma in file di authoring Aggrega in bozza, ciascuno scritto come import:<format> — ad esempio import:terraform. Il prefisso fa parte della voce, quindi un plugin che annuncia più formati elenca una voce per formato. Le voci preservano l’ordine dell’autore. Un formato di importazione richiesto si risolve nell’importer il cui elenco contiene la voce corrispondente; un formato che nessun importer annuncia arresta l’importazione, e un formato annunciato da più di un plugin importer provoca un arresto per ambiguità, a meno che una voce plugins.importer nella configurazione del workspace non ne associ uno, che viene allora eseguito. Un elenco vuoto o assente non dichiara alcun formato, quindi il plugin non importa nulla.
detectobject[]noGestito dalla macchina, da non scrivere a mano: derivato dall’autodichiarazione del .wasm del plugin quando l’entità viene generata a partire da esso, e registrato qui nell’ordine in cui l’autodichiarazione le dichiara. Le firme da cui si riconosce una sorgente nei formati di questo importer quando un’importazione non nomina alcun formato. aggrega import legge le firme di ogni importer contenuto nel catalogo del workspace, comprese tutte le versioni, e degli importer del nucleo del compilatore, le confronta con la sorgente senza sapere che cosa sia alcun formato, e legge la sorgente come il formato dell’unico importer la cui firma corrisponde; una sorgente a cui nessuna firma corrisponde viene rifiutata chiedendo il formato, e una sorgente a cui corrispondono firme di più di un formato viene rifiutata nominandoli. Un importer che riconosce una sorgente la riconosce come ciascun formato che annuncia, quindi per un importer che annuncia più di un formato ogni corrispondenza viene rifiutata per ambiguità. Dove presente, l’elenco deve essere uguale a ciò che dichiara l’autodichiarazione del plugin, voce per voce e nello stesso ordine, e il caricamento e la pubblicazione rifiutano un plugin la cui autodichiarazione differisce, nominando questo campo. Se assente, non fa alcuna dichiarazione e non viene confrontato, e i formati dell’importer sono allora raggiungibili solo nominandoli.

Non sono consentite proprietà aggiuntive.

plugin.spec.importer.detect[]
ProprietàTipoObbligatoriaDescrizione
syntaxstringsìIl formato sintattico in cui viene analizzata la sorgente — json o yaml, ad esempio — che è il formato che un plugin parser annuncia come parse:<syntax>. La sorgente viene analizzata tramite il parser che il catalogo del workspace fornisce per quella sintassi oppure, per una sintassi per cui il catalogo non ne fornisce alcuno, tramite quello che il compilatore porta con sé, al massimo una volta qualunque sia il numero di firme che nominano la sintassi, e una sorgente che non può essere analizzata in essa non corrisponde ad alcuna firma che la nomina. Una sintassi per cui né l’uno né l’altro fornisce un parser interrompe il riconoscimento, nominando l’assenza di quel parser. Lungo almeno 1 carattere.
filesstring[]noI pattern di nome file a cui si applica la firma, confrontati con la parte finale del nome della sorgente con i suoi separatori letti come barre: un pattern di un solo segmento con il nome proprio del file, e un pattern di più segmenti separati da barre con altrettanti segmenti finali del suo percorso, così .vscode/mcp.json corrisponde a un file di nome mcp.json in una directory di nome .vscode. All’interno di un segmento * corrisponde a qualsiasi sequenza di caratteri, ? a un carattere e [...] a un carattere di una classe. La firma si applica quando un pattern qualsiasi corrisponde. Se assente o vuoto, la firma si applica a una sorgente costituita da un solo file, comunque si chiami, e a nessun file di una directory. I pattern delle firme di un importer sono anche ciò che decide quali file di una directory aggrega import gli passa.
matchobject[]noI predicati che l’albero analizzato deve soddisfare, tutti, nell’ordine dichiarato. Se assente o vuoto, non chiede nulla all’albero oltre all’essere analizzabile nella sintassi.

Non sono consentite proprietà aggiuntive.

plugin.spec.importer.detect[].match[]
ProprietàTipoObbligatoriaDescrizione
pathstringsìIl punto dell’albero in cui guarda il predicato, scritto come chiavi unite da punti a partire dalla cima dell’albero: data.nodes nomina il membro nodes dell’oggetto data di primo livello. Un segmento scritto come numero intero, 0 o maggiore, seleziona quella posizione di un array contando da zero, così nodes.0.type nomina il tipo del primo nodo; ogni altro segmento seleziona un membro di un oggetto. Lungo almeno 1 carattere.
isstring (enum)sìCiò che il percorso deve raggiungere: present è soddisfatto quando raggiunge un valore di qualsiasi tipo, null compreso; absent è soddisfatto quando non raggiunge nulla; object, array, string, number e boolean sono ciascuno soddisfatti quando raggiunge un valore di quel tipo. Valori consentiti: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringnoUna stringa a cui il valore raggiunto dal percorso deve essere esattamente uguale; un valore che non è una stringa non le è mai uguale. Su un predicato si dichiara al massimo uno tra equals e prefix. Lungo almeno 1 carattere.
prefixstringnoUna stringa con cui il valore raggiunto dal percorso deve iniziare; un valore che non è una stringa non inizia mai con essa. Su un predicato si dichiara al massimo uno tra equals e prefix. Lungo almeno 1 carattere.

Non sono consentite proprietà aggiuntive.