Aggrega-Schema für den Wasm-Socket describe
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json
Die Übertragungsform, die jedes Wasm-Plugin von seinem Export describe() zurückgibt (PluginDescriptor). describe() ist die Selbstdeklaration des Plugins, die der Host einmal liest, wenn er das Plugin lädt: die ABI-Version, gegen die der Guest bindet, der Plugin-Typ, die angebotenen Exports mit der Fähigkeitsdeklaration jedes Exports, eine Selbstauskunft über die Fähigkeiten auf Plugin-Ebene, ein optionaler Render-Verhaltensvertrag des Providers, ein optionaler Erkennungsvertrag des Importers, optionale CLI-Befehle, ein optionales Einstellungsschema und optionale Urheberschaftsmetadaten. Eine Form deckt jeden Plugin-Typ ab — Provider, Linter, Schritt der feature-recipe-Pipeline, Governance, CLI, Parser und Importer. Der Host liest describe(), bevor er irgendeinen anderen Export aufruft, und lehnt einen Deskriptor ab, den er nicht zulassen kann, statt das Plugin beim Dispatch falsch aufzurufen.
Eine der folgenden Formen
PluginDescriptor
Definitionen
PluginDescriptor
Die vollständige Selbstdeklaration eines Plugins, die von describe() zurückgegeben und einmal beim Laden gelesen wird. Sie enthält den Handshake zur ABI-Kompatibilität, den Plugin-Typ, die angebotenen Exports und die optionalen typspezifischen Oberflächen (den Render-Verhaltensvertrag eines Providers, den Erkennungsvertrag eines Importers, die Befehle eines CLI-Plugins, ein Einstellungsschema, Urheberschaftsmetadaten).
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
abi_version | const “v1beta1” | ja | Die Plugin-ABI, gegen die der Guest bindet. Der Host akzeptiert genau diese Version; ein gegen eine andere ABI gebauter Guest wird beim Laden abgelehnt, statt beim Dispatch falsch aufgerufen zu werden. Konstante: "v1beta1" |
plugin_type | string (enum) | ja | Die Art des Plugins. Sie wählt die Mindest-Export-Regel, die der Host validiert, und zusammen mit dem Export-Namen das Standardmuster der Eingabezustellung. Ein Governance-Plugin bedient die Transformations- und Urteilsrollen der Build-Pipeline; die Rolle, in der es angebunden ist — nicht seine Art —, legt fest, was es ausgeben darf. Zulässige Werte: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer" |
capabilities | string[] | nein | Was das Plugin bedient. Die Liste ist in der Übertragungsform flach, und das benachbarte erforderliche plugin_type legt fest, welchen der vier Sinne jeder Eintrag trägt: für einen Provider die Fähigkeitsnamen (etwa helm oder compose), deren Ausgabeform er rendert; für einen Schritt der feature-recipe-Pipeline die Provider-Fähigkeiten, mit denen sein Schritt kompatibel ist; für einen Parser die Quellformate, die er in einen kanonischen strukturierten Baum überführt, jeweils geschrieben als parse: |
exports | PluginExport[] | ja | Die Exports, die das Plugin anbietet, in deklarierter Reihenfolge. Der Host validiert, dass der typspezifische Mindest-Export vorhanden ist, und bindet die Host-Oberfläche jedes Exports, bevor er ihn aufruft. |
contract | ProviderContract | nein | Die Selbstauskunft des Providers über sein Render-Verhalten — die Eingabearten, die er rendert, wie er die Ausgabe pro Knoten einer Dispatch-Gruppe zusammensetzt, und das Delimiter-Paar der Artefakt-Templates, das er anwendet. Sie beschreibt den Provider als Ganzes statt eines einzelnen Exports. Fehlt bei einem Plugin, das keinen Render-Verhaltensvertrag deklariert. |
importer | ImporterContract | nein | Die Selbstauskunft eines Importers darüber, wie eine Quelle der von ihm angekündigten Formate erkannt wird, wenn ein Import kein Format nennt. Nur ein Plugin, dessen plugin_type importer ist, darf sie deklarieren; jedes andere Plugin, das sie deklariert, wird beim Laden abgelehnt. Fehlt bei einem Importer, der keine Möglichkeit deklariert, seine Formate zu erkennen; seine Formate werden dann nur erreicht, indem man sie nennt. |
description | string | nein | Die eigene einzeilige, menschenlesbare Beschreibung des Plugins dazu, was es tut, getrennt von der Beschreibung eines einzelnen Exports und von der Metadaten-Beschreibung der Entität. Sie ist informativ; der Host validiert sie weder noch handelt er danach. |
commands | PluginCLICommand[] | nein | Die aggrega-Befehlsverben der obersten Ebene, die ein CLI-Plugin beisteuert, jeweils mit einer eigenen Kurzhilfezeile. Ein CLI-Plugin kann mehrere Befehle beisteuern; der Host registriert einen Befehl pro Eintrag und leitet den aufgelösten Befehlsnamen beim Aufruf an den Guest weiter. Ein Nicht-CLI-Plugin lässt sie leer. |
settings_schema | object | nein | Ein optionales JSON-Schema-Dokument, das ein Plugin deklariert, um die vom Operator gelieferten Einstellungen zu typisieren, die seine Anbindung trägt. Wenn es vorhanden ist, kompiliert der Host es beim Laden und validiert die Einstellungen der Anbindung beim Dispatch dagegen, bevor er das Plugin aufruft; nicht konforme Einstellungen halten den Build an. Wenn es fehlt, deklariert das Plugin keine Form, und die Einstellungen werden unverändert durchgereicht. Das Schema ist die eigene, frei gestaltete Deklaration des Plugins; der Host führt eine generische JSON-Schema-Validierung dagegen aus und interpretiert die Bedeutung der Einstellungen nicht. |
metadata | PluginDescriptorMeta | nein | Optionale Informationen zu Urheberschaft und Build-Herkunft. Sie tragen keinen Verhaltensvertrag — der Host validiert sie weder noch handelt er danach. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginExport
Ein Export, den ein Plugin anbietet, wie in describe() deklariert. Der Host dispatcht an den Export über dessen Namen und bindet die Host-Oberfläche mit minimalen Rechten, die die deklarierten Host-Funktionen des Exports erfordern.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der ABI-Name des Exports — zum Beispiel render_node, assemble_boundary, lint_rules oder step. Der Host dispatcht an den Export über diesen Namen. |
input_pattern | string (enum) | nein | Wie der Host die Eingabe des Exports zustellt: b stellt die vollständige Payload inline zu, sodass der Guest allein aus der Payload rendert; a stellt eine kleine Payload zu, die der Guest über Host-Funktionen anreichert. Ein Export, der dieses Feld weglässt, übernimmt den Standardwert seines Plugin-Typs und seines Namens. Zulässige Werte: "a", "b" |
host_functions | string[] | nein | Die Namen der Host-Funktionen, die dieser Export importiert. Jeder Name muss in der Allowlist der Host-Funktionen stehen. Die Deklaration ist maßgeblich und wird beim Laden mit den Funktionen abgeglichen, die der Guest tatsächlich aus seinem Modul importiert, sodass sie nicht von den Funktionen abweichen kann, die der Guest wirklich aufruft. |
description | string | nein | Optionaler menschenlesbarer Text, der den Export beschreibt. Er ist Dokumentation für die Leser des Katalogs; der Host validiert ihn weder noch handelt er danach. |
stability | string (enum) | nein | Die Stabilitätsstufe des Exports. Ein weggelassener Wert trägt keine Stabilitätsbehauptung. Zulässige Werte: "stable", "experimental", "deprecated" |
operates | string (enum) | nein | Die Pipeline-Operation, die dieser Export ausführt: patch ändert ein vorhandenes gerendertes Dokument, emit fügt ein neues Dokument hinzu. Die Form des Werts wird beim Laden geprüft; die Runtime liest ihn, wenn sie den Schritt dispatcht. Zulässige Werte: "patch", "emit" |
scope | string (enum) | nein | Die Dokumentwurzel, auf der dieser Export arbeitet: own sind die eigenen gerenderten Dokumente des Knotens, host sind die Dokumente der Komponente, an die ein Feature-Rezept mit Komponenten-Geltungsbereich angebunden ist. Die Form des Werts wird beim Laden geprüft; die Runtime löst die Dokumente des Geltungsbereichs auf, wenn sie dispatcht. Zulässige Werte: "own", "host" |
selector | string | nein | Eine frei gestaltete, menschenlesbare Beschreibung dessen, worauf der Export wirkt. Sie ist Dokumentation für die Leser des Katalogs; der Host validiert ihren Inhalt weder noch handelt er danach. |
input | object | nein | Ein optionales JSON-Schema-Dokument, das ein Step-Export deklariert, um die schrittlokale Eingabe zu typisieren, die ein Pipeline-Eintrag über seinen with-Block liefert. Wenn es vorhanden ist, beschreibt es die Form, die die with-Eingabe eines Schritts erfüllt; wenn es fehlt, deklariert der Export keinen Eingabevertrag. Das Schema ist die eigene, frei gestaltete Deklaration des Exports über die Eingabeoberfläche, auf die ein Pipeline-Autor für diesen Export abzielt. |
output | object | nein | Ein optionales JSON-Schema-Dokument, das ein Step-Export deklariert, um die Ausgaben zu typisieren, die er für einen Schritt zurückgibt — die Form der adressierbaren Ausgaben, die ein Schritt beisteuert, damit ein späterer Schritt oder ein Template sie liest. Wenn es vorhanden ist, beschreibt es die Form dieser zurückgegebenen Ausgaben; wenn es fehlt, deklariert der Export keinen Ausgabevertrag. Das Schema ist die eigene, frei gestaltete Deklaration des Exports über die Ausgabeoberfläche, die dieser Export erzeugt. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginCLICommand
Ein aggrega-Befehlsverb der obersten Ebene, das ein CLI-Plugin beisteuert, wie in describe() deklariert. Der Host registriert einen Befehl pro Eintrag und leitet den aufgelösten Befehlsnamen beim Aufruf an den Guest zurück, sodass ein einzelner Guest mehrere Befehle bedienen und sein Verhalten anhand des Namens wählen kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Das Befehlsverb, das der Host registriert — das aggrega-Token, das ein Operator aufruft, und der Diskriminator, den der Host dem Guest übergibt, damit dieser danach verzweigen kann, welcher Befehl aufgerufen wurde. Jeder deklarierte Befehl muss es nennen. |
description | string | nein | Der einzeilige Kurzhilfetext des Befehls, angezeigt in der Befehlsliste und in der Hilfeausgabe. Er ist optionale Dokumentation; der Host validiert ihn weder noch handelt er danach. |
flags | PluginCommandFlag[] | nein | Die Flags des Befehls, in deklarierter Reihenfolge. Jeder Eintrag steuert ein Flag bei, das der Host am Befehl registriert, sodass aggrega help |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginCommandFlag
Ein Flag, das ein CLI-Plugin an einem Befehl deklariert, wie in describe() gemeldet. Der Host registriert es am Befehl, sodass aggrega help
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der lange Name des Flags — das Token —name, das ein Operator auf der Kommandozeile übergibt. Jedes deklarierte Flag muss ihn angeben. Mindestens 1 Zeichen lang. |
shorthand | string | nein | Der optionale Kurzalias des Flags aus einem einzigen Zeichen — die Form -x, die ein Operator statt des langen Namens übergeben kann. Fehlt er, hat das Flag keinen Kurzalias. |
description | string | nein | Der einzeilige Hilfetext des Flags, angezeigt in der Hilfeausgabe des Befehls. Er ist optionale Dokumentation; der Host validiert ihn weder, noch handelt er danach. |
type | string | nein | Der Werttyp des Flags — zum Beispiel string, bool oder int. Fehlt er, trägt er keine Typbehauptung. |
default | string | nein | Der Standardwert des Flags, wenn der Operator es nicht übergibt, ausgedrückt als String. Fehlt er, deklariert das Flag keinen Standardwert. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginDescriptorMeta
Optionale Metadaten zu Urheberschaft und Build-Herkunft, die ein Plugin in describe() deklariert. Sie sind informativ; der Host validiert sie nicht und handelt nicht danach. Die Felder version und commit sind Build-Herkunft, die zur Build-Zeit in den Guest gestempelt wird; ein ungestempelter Build lässt sie weg.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
author | string | nein | Der Autor des Plugins. |
repository | string | nein | Das Quell-Repository des Plugins. |
license | string | nein | Die Lizenzkennung des Plugins. |
version | string | nein | Die Version der Build-Herkunft, die zur Build-Zeit in den Guest gestempelt wird. Fehlt bei einem ungestempelten Build. |
commit | string | nein | Der kurze Commit der Build-Herkunft, aus dem der Guest gebaut wurde. Fehlt bei einem ungestempelten Build. |
Zusätzliche Eigenschaften sind nicht zulässig.
ProviderContract
Die Selbstdeklaration eines Providers über die Render-Verhaltensweisen zur Kompilierzeit, die er über die von ihm gerenderten Knoten hinweg ausführt — die Eingabearten, die er akzeptiert, ob und wie er die Ausgabe pro Knoten einer Dispatch-Gruppe zu einem einzigen Artefakt zusammensetzt, das Go-Template-Delimiter-Paar, das er auf importierte Artefaktdateien anwendet, ob er die Dateien akzeptiert, die ein Recipe zur gemeinsamen Ausgabe seiner Boundary beisteuert, und die Dateien, die sein Ökosystem nie neben einer Quelle ausliefert. Sie beschreibt den Provider als Ganzes, nicht einen einzelnen Export. Das Lade-Gate gleicht sie mit der verfassten Behauptung der Entität ab.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
input_kinds | InputKinds | ja | Welche der drei Recipe-Eingabearten das Plugin rendert: eine Dateimenge aus einer Quelle, eine synthetisierte Workload und einen eigenständigen Knoten nur mit Artefakten. |
boundary_assembly | string (enum) | ja | Wie das Plugin die Render-Ausgabe pro Knoten einer Dispatch-Gruppe kombiniert: none schreibt die Ausgabe jedes Knotens direkt an den Dispatch-Pfad, merge führt die Fragmente pro Knoten in ein Dokument zusammen, und nest legt die Ausgabe jedes Knotens an ihrer eigenen Position in einer Dachstruktur ab. Ein leerer Wert trägt keine Zusammensetzungsbehauptung. Zulässige Werte: "none", "merge", "nest", "" |
artifact_delimiters | ArtifactDelimiters | nein | Das Go-Template-Delimiter-Paar, das das Plugin auf importierte Artefaktdateien anwendet. Fehlt es, gilt das Standardpaar aus öffnendem und schließendem Delimiter; ein Plugin, dessen Zielsyntax mit diesem Paar kollidiert, meldet hier ein alternatives Paar. |
assembly_name_annotation | AssemblyNameAnnotation | nein | Eine Boundary-Annotation, deren aufgelöster Wert das Artefakt benennt, das das Plugin aus einer Dispatch-Gruppe zusammensetzt. Fehlt sie, benennt das Plugin seine Zusammensetzung allein anhand des Dispatch-Pfads. |
reusable_instance | boolesch | nein | Ob eine einzige geladene Plugin-Instanz jeden Render-, Zusammensetzungs- und Validierungsübergang des Builds bedienen darf statt einer frischen Instanz pro Übergang. Ein Plugin deklariert es nur dann als true, wenn es über Übergänge hinweg keinen Zustand hält. Fehlend (false) ist der sichere Standard: Der Host lädt pro Übergang eine frische Instanz. |
cross_boundary_linking | boolesch | nein | Ob das Plugin Boundary-übergreifende uses-Kanten verdrahtet — Kanten, deren konsumierendes und konsumiertes Ende in unterschiedliche Dispatch-Gruppen zusammengesetzt werden —, indem es über seine Exports link_publish und link_resolve eine Provider-native Querverweis-Verdrahtung erzeugt. Ein Plugin deklariert es nur dann als true, wenn es beide exportiert. Fehlend (false) ist der sichere Standard: Das Plugin verdrahtet keine Boundary-übergreifenden Kanten. |
omits | boolesch | nein | Ob das Plugin die omit-Einträge berücksichtigt, die eine render_node-Eingabe trägt: Es lässt jede gerenderte Einheit, auf die ein Eintrag passt, aus allem weg, was es zurückgibt, und meldet im Feld omitted der Ausgabe einen Zählwert pro übergebenem Eintrag. Ein Plugin deklariert es nur dann als true, wenn es beides tut. Fehlend (false) ist der sichere Standard: Das Plugin beansprucht nicht, etwas wegzulassen. |
boundary_artifacts | boolesch | nein | Ob das Ziel des Plugins die Dateien akzeptiert, die ein Recipe zur gemeinsamen Ausgabe der Boundary beisteuert, in der es rendert. Der Host wertet diese Dateien aus und schreibt jede einmal, in das Verzeichnis, das die zusammengesetzte Ausgabe der Dispatch-Gruppe enthält, neben das, was die Zusammensetzung des Plugins schreibt; dem Plugin wird keine davon übergeben und es liest keine davon, sodass die Behauptung eine Aussage ist, dass sein Ziel eine dort abgelegte Datei als Teil der Ausgabe der Boundary behandelt. Fehlend (false) ist der sichere Standard: Ein Recipe, das solche Dateien für dieses Plugin deklariert, wird abgelehnt, bevor irgendetwas gerendert wird. |
nest_segment | string | nein | Das Verzeichnis, unter dem das Ziel des Plugins das eigene Unterverzeichnis jedes Beitragenden ablegt, für ein Plugin, das die Ausgabe pro Knoten einer Dispatch-Gruppe verschachtelt. Der Host fügt dieses Segment, den Namen des Beitragenden auf Authoring-Ebene und den eigenen Pfad jeder Datei zusammen. Wird nur gelesen, wenn boundary_assembly nest ist. Fehlt es, legt der Host das Unterverzeichnis jedes Beitragenden direkt an der Dispatch-Position ab, ohne umschließendes Verzeichnis. Der Wert nennt ein Verzeichnis und niemals einen Pfad: Ein Wert, der ein Pfadtrennzeichen enthält oder das aktuelle oder das übergeordnete Verzeichnis nennt, wird abgelehnt, weil der Host den Namen des Beitragenden darin einsetzt und ein Pfadfragment die Dateien eines Beitragenden an einem anderen Ort als unterhalb der Dispatch-Position ablegen würde. |
source_ignore | SourceIgnore | nein | Die Dateien, die das Ökosystem dieses Plugins nie neben einer von ihm gerenderten Quelle ausliefert, deklariert als Ignore-Regeln. Der Host liest die Deklaration, wenn ein Autor ein Recipe oder FeatureRecipe pinnt, dessen Fähigkeit dieses Plugin für ihn bedient: Er kombiniert diese Regeln mit der eigenen Ignore-Datei des Autors, hält die kombinierten Regeln im Lock der Entität neben der Entität fest, und von da an wenden jede Veröffentlichung der Entität, jeder Vergleich ihrer lokalen Quelle und jedes Rendern von ihr die festgehaltenen Regeln an, statt erneut ein Plugin zu fragen. So trägt ein für eine Fähigkeit veröffentlichtes Recipe die Dateien, die die Regeln seines Herausgebers behalten haben, und ein Plugin rendert es, wenn es dieselbe ABI-Version spricht, sein Vertrag zur Behauptung seiner Entität passt und es keine Datei außerhalb dieser Menge benötigt. Ein Plugin, das eine Datei benötigt, die die Menge ausgelassen hat, muss seinen Build ausdrücklich fehlschlagen lassen und die Datei nennen; die Aufgabe des Hosts ist es, das Packen oder das Lesen einer Datei abzulehnen, die die Menge nicht enthält, und sie dabei zu nennen. Fehlt sie, werden keine Ignore-Regeln deklariert, und eine Quelle, die das Plugin rendert, behält dann jede Datei, die die eigenen Regeln des Autors behalten. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceIgnore
Die Ignore-Regeln, die das Ökosystem eines Plugins auf ein Quellverzeichnis anwendet, in gitignore-Syntax: Ein Muster ohne Schrägstrich oder nur mit einem abschließenden passt auf einen Namen in beliebiger Tiefe, ein Muster mit einem anderen Schrägstrich wird ab der Wurzel des Verzeichnisses gelesen, auf das es beschränkt ist, ein abschließender Schrägstrich passt nur auf ein Verzeichnis, und ein führendes ! holt zurück, was eine frühere Regel ausgeschlossen hat. Die Regeln gelten der Reihe nach, und ein späterer Treffer setzt sich über einen früheren hinweg. Ein Verzeichnis, das eine Regel ausschließt, wird nicht betreten, sodass nichts darunter zurückkommt, es sei denn, das Verzeichnis selbst wird zuvor zurückgeholt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
patterns | string[] | nein | Die eigenen Ignore-Muster des Ökosystems, jeweils auf die Wurzel des lokalen Quellverzeichnisses beschränkt, das durchlaufen wird, in der Reihenfolge, in der sie gelten. Fehlend oder leer deklariert keine. |
files | string[] | nein | Die Namen der Ignore-Dateien, die das Ökosystem innerhalb einer Quelle berücksichtigt — zum Beispiel .helmignore für ein Chart. Wo immer der Durchlauf einer Quelle eine Datei mit einem dieser Namen findet, werden ihre Zeilen als weitere Muster in derselben Syntax gelesen, jeweils auf das Verzeichnis beschränkt, das die Datei enthält, und sie gelten nach den obigen Mustern; eine Leerzeile und eine Zeile, die mit # beginnt, werden übersprungen. Eine Datei mit einem solchen Namen wird selbst mitgeführt, es sei denn, eine Regel schließt sie aus. Fehlend oder leer nennt keine. |
Zusätzliche Eigenschaften sind nicht zulässig.
InputKinds
Welche Recipe-Eingabearten ein Plugin rendert. Jedes Feld ist eine unabhängige Behauptung; ein Plugin kann jede beliebige Kombination melden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
sourced | boolesch | ja | Ob das Plugin eine Dateimenge aus einer Quelle rendert (ein Chart, ein Modul, eine Compose-Datei). |
synthesized | boolesch | ja | Ob das Plugin eine synthetisierte Workload rendert. |
artifacts_standalone | boolesch | ja | Ob das Plugin einen eigenständigen Knoten nur mit Artefakten rendert — einen, der importierte Artefaktdokumente und weder eine Quelle noch eine Workload trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ArtifactDelimiters
Das Go-Template-Delimiter-Paar, das ein Plugin auf importierte Artefaktdateien anwendet, gemeldet, wenn es vom Standardpaar abweicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
left | string | ja | Der öffnende Begrenzer. |
right | string | ja | Der schließende Begrenzer. |
Zusätzliche Eigenschaften sind nicht zulässig.
AssemblyNameAnnotation
Die Boundary-Annotation, deren aufgelöster Wert das zusammengesetzte Artefakt eines Plugins benennt, gemeldet, wenn das Plugin die beitragenden Boundaries einer Dispatch-Gruppe zu einer einzigen benannten Zusammensetzung zusammenführt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
annotation | string | ja | Der Schlüssel der Boundary-Annotation, aus dem das Plugin den Namen des zusammengesetzten Artefakts liest. |
require_unique | boolesch | nein | Ob sich jede Boundary, die zu einer Dispatch-Gruppe beiträgt, auf den aufgelösten Wert der Annotation einigen muss. Wenn true, bricht eine Gruppe, deren beitragende Boundaries die Annotation zu unterschiedlichen Werten auflösen, den Build ab; wenn false, akzeptiert das Plugin den ersten aufgelösten Wert. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImporterContract
Was ein Importer über seine Formate deklariert, über deren Ankündigung hinaus: die Signaturen, an denen eine Quelle dieser Formate erkannt wird. Wenn ein Import kein Format nennt, liest der Host die Signaturen, die jeder Importer verzeichnet, unter denen der Import auswählt — die Importer im Katalog des Workspace und die Kern-Importer des Compilers, deren Plugin-Entitäten das Binary mitbringt —, gleicht jede mit der Quelle ab, ohne zu wissen, was irgendein Format ist, und liest die Quelle als das Format des einen Importers, dessen Signatur passt. Eine Quelle, auf die keine Signatur passt, wird mit der Aufforderung abgelehnt, das Format anzugeben, und eine Quelle, auf die Signaturen mehr als eines Formats passen, wird unter Nennung dieser Formate abgelehnt. Die Plugin-Entität verzeichnet dieselbe Liste, und der Host lehnt einen Importer ab, dessen describe()-Bericht vom Verzeichneten abweicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
detect | DetectSignature[] | nein | Die Signaturen, die eine Quelle der Formate dieses Importers erkennen, in deklarierter Reihenfolge; eine Quelle wird erkannt, wenn irgendeine von ihnen auf sie passt. Eine von einem Importer erkannte Quelle wird als jedes Format erkannt, das der Importer ankündigt, sodass bei einem Importer, der mehr als ein Format ankündigt, jeder Treffer als mehrdeutig abgelehnt wird, und ein Importer, dessen Quellen erkannt werden müssen, kündigt ein einziges Format an. Fehlend oder leer deklariert keine Signatur, und die Formate des Importers werden nur erreicht, indem man sie nennt. |
Zusätzliche Eigenschaften sind nicht zulässig.
DetectSignature
Eine Art, wie eine Quelle erkannt wird: die Syntax, in der die Quelle gelesen wird, die Dateinamen, auf die die Signatur zutrifft, und die Prädikate, die der geparste Baum erfüllen muss. Sie passt auf eine Datei, deren Name auf eines ihrer Dateimuster passt — oder, wo sie keines deklariert, auf eine Quelle, die aus einer einzigen Datei besteht, wie auch immer sie heißt —, deren Bytes sich in ihrer Syntax parsen lassen und deren geparster Baum jedes ihrer Prädikate erfüllt. Sie passt auf ein Verzeichnis, wenn sie auf eine der Dateien des Verzeichnisses passt, die ihre Muster auswählen, sodass eine Signatur, die kein Muster deklariert, auf kein Verzeichnis passt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
syntax | string | ja | Das syntaktische Format, als das die Quelle geparst wird — zum Beispiel json oder yaml —, also das Format, das ein Parser-Plugin als parse: |
files | string[] | nein | Die Dateinamenmuster, auf die die Signatur zutrifft, abgeglichen mit dem Ende des Namens der Quelle, wobei ihre Trennzeichen als Schrägstriche gelesen werden: Ein Muster aus einem Segment wird mit dem eigenen Namen der Datei abgeglichen, und ein Muster aus mehreren durch Schrägstriche getrennten Segmenten mit ebenso vielen abschließenden Segmenten ihres Pfads, sodass .vscode/mcp.json auf eine Datei namens mcp.json in einem Verzeichnis namens .vscode passt. Innerhalb eines Segments passt * auf eine beliebige Zeichenfolge, ? auf ein Zeichen und […] auf ein Zeichen einer Klasse. Die Signatur trifft zu, wenn irgendein Muster passt. Ein nicht wohlgeformtes Muster wird beim Laden abgelehnt. Fehlend oder leer wendet die Signatur auf eine Quelle an, die aus einer einzigen Datei besteht, wie auch immer sie heißt, und auf keine Datei eines Verzeichnisses. Die Muster der Signaturen eines Importers entscheiden auch darüber, welche Dateien eines Verzeichnisses ein Import ihm übergibt. |
match | PathMatch[] | nein | Die Prädikate, die der geparste Baum erfüllen muss, alle, in der deklarierten Reihenfolge. Fehlt es oder ist es leer, wird vom Baum nichts verlangt, außer dass er sich in der Syntax parsen lässt. |
Zusätzliche Eigenschaften sind nicht zulässig.
PathMatch
Ein Prädikat über den geparsten Baum: der Wert, den ein Pfad erreicht, die Art von Wert, die er sein muss, und optional eine Zeichenkette, der er gleichen oder mit der er beginnen muss.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Wo im Baum das Prädikat nachsieht, geschrieben als durch Punkte verbundene Schlüssel ab der Spitze des Baums: data.nodes nennt das Mitglied nodes des Objekts data der obersten Ebene. Ein als ganze Zahl geschriebenes Segment, 0 oder größer, wählt diese Position eines Arrays, von null an gezählt, sodass nodes.0.type den type des ersten Knotens nennt; jedes andere Segment wählt ein Mitglied eines Objekts. Ein Schlüssel, der selbst einen Punkt enthält, kann nicht genannt werden. Mindestens 1 Zeichen lang. |
is | string (enum) | ja | Was der Pfad erreichen muss: present gilt, wenn er einen Wert beliebiger Art erreicht, null eingeschlossen; absent gilt, wenn er nichts erreicht; object, array, string, number und boolean gelten jeweils, wenn er einen Wert dieser Art erreicht. Zulässige Werte: "present", "absent", "object", "array", "string", "number", "boolean" |
equals | string | nein | Eine Zeichenkette, der der Wert, den der Pfad erreicht, genau gleichen muss. Ein Wert, der keine Zeichenkette ist, gleicht ihr nie. Auf einem Prädikat wird höchstens eines von equals und prefix deklariert, und ein Prädikat, das beide deklariert, wird beim Laden abgelehnt. Mindestens 1 Zeichen lang. |
prefix | string | nein | Eine Zeichenkette, mit der der Wert, den der Pfad erreicht, beginnen muss. Ein Wert, der keine Zeichenkette ist, beginnt nie mit ihr. Auf einem Prädikat wird höchstens eines von equals und prefix deklariert, und ein Prädikat, das beide deklariert, wird beim Laden abgelehnt. Mindestens 1 Zeichen lang. |
Zusätzliche Eigenschaften sind nicht zulässig.