Aggrega-Schema für den Kern (Plugin)
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/plugin-v1beta1.schema.json
Ein Wasm-Plugin: ein WebAssembly-Modul, das in einer OCI-Registry veröffentlicht und durch sein metadata.pluginType — den Socket, den es implementiert — plus seinen bloßen metadata.name identifiziert wird und die ABI-Version, auf die es abzielt, einen optionalen Signaturverweis und einen optionalen Runtime-Block deklariert. Die Entität und ihr .wasm werden als ein einziges OCI-Manifest veröffentlicht, das mit metadata.version getaggt ist — das YAML der Entität als Konfigurations-Blob im Manifest, das .wasm als Inline-Layer, einmal signiert. Die Identität ist die Koordinate metadata.pluginType/metadata.name plus die metadata.version der Entität; der Ort des .wasm wird aus dieser Koordinate plus der konfigurierten Registry abgeleitet, und der aufgelöste Inhalts-Digest liegt im Lockfile, nicht in der Entität. Das Lockfile zeichnet den Digest auf, und die Vertrauensrichtlinie pro Registry prüft die Signatur des Artefakts beim Pull. Der Compiler interpretiert das Verhalten des Plugin nicht — er routet die Referenz; die WebAssembly-Runtime führt die Bytes aus.
Siehe die Authoring-Referenz zum Plugin für Anleitungen in Prosaform zum Verfassen von Plugin-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.
Typ der obersten Ebene: object
Eigenschaften
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | ja | Konstante: "aggrega.ai/v1beta1" |
kind | const “Plugin” | ja | Konstante: "Plugin" |
metadata | object | ja | |
spec | object | ja | Die ABI-Version, auf die das Plugin abzielt, ein optionaler Signaturverweis und ein optionaler Runtime-Block. Der Ort des .wasm des Plugin wird aus der Identität des Plugin abgeleitet — seinem metadata.pluginType (dem Socket) plus seinem bloßen metadata.name — und aus der konfigurierten Registry; er wird nicht in der spec geführt. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.metadata
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Mindestens 1 Zeichen lang. |
version | string | ja | Strikte semantische Versionierung der Plugin-Entität (z. B. 1.0.0). Muster: ^(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-]+)*))?$. |
pluginType | string (enum) | ja | Der Socket-Typ, den dieses Plugin implementiert. Ein Plugin implementiert genau einen Socket-Typ aus der Taxonomie der Plugin-Typen, die die Runtime erkennt: provider (rendert IR-Knoten in Provider-native Artefakte), linter (prüft verfassten Inhalt und meldet Diagnosen), pipeline-step (ein Schritt in der pipeline: eines FeatureRecipe oder eines Recipe, der den gerenderten Dokumentsatz patcht), governance (bedient die Governance-Rollen der Build-Pipeline — transformiert Knoten-Labels beim Aufbau der Topologie oder fällt ein Annahme-/Ablehnungsurteil über den IR-Graphen bei der statischen Analyse oder über die gerenderten Artefakte beim Rendern; die Rolle, an die es angebunden ist, nicht seine Art, legt fest, was es ausgeben darf), cli (steuert einen Runtime-Unterbefehl aggrega <cmd> bei, den ein Operator auf der Kommandozeile aufruft — ein Runtime-Socket, verschieden von den Render- und Pipeline-Sockets zur Kompilierzeit), parser (wandelt einen fremden Quelltext in einen kanonischen strukturierten Baum um, sodass ein Konsument den Baum liest, ohne einen eigenen Sprachparser mitzuführen, und weist die Formate, die es verarbeitet, als parse:<format>-Fähigkeiten aus), importer (wandelt eine fremde Infrastruktur- oder Agentendefinitionsquelle in Entwürfe von Aggrega-Authoring-Dateien um und weist die Formate, die es verarbeitet, als import:<format>-Fähigkeiten aus). Zulässige Werte: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer" |
description | string | nein | Was diese Entität ist und wofür sie gedacht ist, geschrieben für jemanden, der entscheidet, ob er sie verwendet. Beginnen Sie mit einem Satz, der die Sache benennt, und ergänzen Sie dann, was ein Leser braucht, um sie auszuwählen und richtig zu verwenden — was sie von dem Build erwartet, der sie ausführt, und alles Überraschende an ihrem Verhalten. Ein kurzer Absatz ist die übliche Länge. |
maintainers | object[] | nein | Liste der Maintainer, die für diese Entität verantwortlich sind. |
license | string | nein | SPDX-Bezeichner für die Lizenz der Software, die diese Entität beschreibt, etwa MIT oder AGPL-3.0. Er hält die Bedingungen dieser Software fest, nicht die Bedingungen dieser Datei. |
repository | string | nein | Die URL des Git-Repositorys, in dem die Quelldateien liegen. |
home | string | nein | Die URL der Homepage, des Wikis oder der Dokumentation dieser Entität. |
keywords | string[] | nein | Eine Liste beschreibender Schlüsselwörter für die Auffindbarkeit in der Benutzeroberfläche. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.metadata.maintainers[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | |
email | string | nein | |
url | string | nein |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec
Die ABI-Version, auf die das Plugin abzielt, ein optionaler Signaturverweis und ein optionaler Runtime-Block. Der Ort des .wasm des Plugin wird aus der Identität des Plugin abgeleitet — seinem metadata.pluginType (dem Socket) plus seinem bloßen metadata.name — und aus der konfigurierten Registry; er wird nicht in der spec geführt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
abiVersion | string (enum) | ja | Die Host/Guest-ABI-Version, auf die das Plugin abzielt. v1beta1 ist der einzige akzeptierte Wert; ein Plugin, das eine ABI-Version deklariert, die dieser Compiler nicht mehr spricht, wird abgelehnt, wobei die Version genannt wird, gegen die das Plugin neu zu bauen ist. Zulässige Werte: "v1beta1" |
signature | object | nein | Ein optionaler beschreibender Verweis auf die angehängte Signatur des Plugin. Dieser Block ist reine Dokumentation — er hält für Leser des Katalogs fest, wo die Signatur liegt und wie sie erzeugt wurde; er selbst sperrt das Plugin weder noch lässt er es zu. Die durchsetzende Prüfung ist die Vertrauensrichtlinie pro Registry, die beim Pull angewendet wird: Eine Signatur wird als OCI-Referrer abgerufen, gegen die vertrauenswürdigen Identitäten oder den festgelegten Schlüssel der Registry geprüft und als verifizierte Tatsache im Lockfile festgehalten. Eine Registry, die Signaturen verlangt, bricht den Pull ab, wenn eine erforderliche Signatur fehlt, nicht vertrauenswürdig oder ungültig ist. |
runtime | object | nein | Optionale Ausführungsbeschränkungen, die der Host beim Laden und Ausführen des Plugin anwendet. Ausgehender Netzwerkzugriff ist kein Authoring-Feld: Ein Plugin erreicht zur Build-Zeit nie das Netzwerk (die Ahead-of-Time-Grenze), daher gibt es hier kein Host-Allowlist-Feld zu verfassen. |
exports | object[] | nein | Die Exporte, die dieses Plugin anbietet, jeweils mit ihrer deklarierten Fähigkeit. Ein Export ist ein benannter Einstiegspunkt, an den der Host Aufrufe weiterleitet (zum Beispiel render_node, lint_naming, step); der Fähigkeitsblock pro Export ist die verfasste Angabe dessen, was dieser Export tut, die der Host beim Veröffentlichen und beim Laden mit der Selbstauskunft des Plugin abgleicht. Einträge behalten die Reihenfolge des Autors bei. Fehlt er, wird keine verfasste Export-Oberfläche deklariert. |
commands | object[] | nein | Maschinenverwaltet, nicht von Hand verfassen: von aggrega plugin sync (oder aggrega plugin gen-catalog) aus der Selbstauskunft des Plugin aufgezeichnet. Die Verben der obersten Ebene aggrega <command>, die ein CLI-Plugin beisteuert, werden aus der Selbstauskunft des Plugin gelesen und hier in der Reihenfolge aufgezeichnet, in der die Selbstauskunft sie deklariert, sodass die Befehlsoberfläche, mit der sich ein CLI-Plugin installiert, aus der Entität lesbar ist, ohne das Plugin zu laden. Ein Nicht-CLI-Plugin steuert keine Befehle bei und zeichnet eine leere Liste auf. Der Host installiert genau diese Menge; eine aufgezeichnete Menge, die von der Selbstauskunft des Plugin abweicht, bricht beim Laden ab, und die Veröffentlichung lehnt eine Menge ab, die nicht mit dem Binary synchron ist, und fordert den Autor auf, sie neu aufzuzeichnen. |
provider | object | nein | Der Provider-Socket-Block für ein Plugin mit pluginType: provider: die Fähigkeiten, die es bedient, wie es die Workload-Art aggrega.ai/v1beta1 übersetzt, welche plattformnativen Annotationen es liest, und sein Vertrag für das Render-Verhalten. Nur bei Provider-rendernden Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ. |
pipelineStep | object | nein | Der Pipeline-Step-Block für ein Plugin mit pluginType: pipeline-step: die Provider-Fähigkeiten, mit denen sein Schritt kompatibel ist. Nur bei Pipeline-Step-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ. |
parser | object | nein | Der Parser-Block für ein Plugin mit pluginType: parser: die Quellformate, die es in einen kanonischen strukturierten Baum umwandelt. Nur bei Parser-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ. |
importer | object | nein | Der Importer-Block für ein Plugin mit pluginType: importer: die fremden Quellformate, die es in Entwürfe von Aggrega-Authoring-Dateien umwandelt, und die Signaturen, an denen eine Quelle dieser Formate erkannt wird. Nur bei Importer-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.signature
Ein optionaler beschreibender Verweis auf die angehängte Signatur des Plugin. Dieser Block ist reine Dokumentation — er hält für Leser des Katalogs fest, wo die Signatur liegt und wie sie erzeugt wurde; er selbst sperrt das Plugin weder noch lässt er es zu. Die durchsetzende Prüfung ist die Vertrauensrichtlinie pro Registry, die beim Pull angewendet wird: Eine Signatur wird als OCI-Referrer abgerufen, gegen die vertrauenswürdigen Identitäten oder den festgelegten Schlüssel der Registry geprüft und als verifizierte Tatsache im Lockfile festgehalten. Eine Registry, die Signaturen verlangt, bricht den Pull ab, wenn eine erforderliche Signatur fehlt, nicht vertrauenswürdig oder ungültig ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
type | const “sigstore-cosign” | ja | Das Signaturschema. sigstore-cosign ist das unterstützte Schema. Konstante: "sigstore-cosign" |
signatureRef | string | nein | Die OCI-Referrer-Referenz des angehängten Signatur-Bundles, zur Dokumentation und Auffindbarkeit. Fehlt, wenn die Signatur beim Pull durch Aufzählung der Referrer gefunden wird, statt hier festgelegt zu sein. |
publicKeyRef | string | nein | Ein Verweis auf den öffentlichen Schlüssel, mit dem die Signatur erzeugt wurde, für eine schlüsselbasierte Signatur. Fehlt er, handelt es sich um eine schlüssellose Signatur (OIDC-Identität), die gegen die vertrauenswürdigen Identitäten der Registry geprüft wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.runtime
Optionale Ausführungsbeschränkungen, die der Host beim Laden und Ausführen des Plugin anwendet. Ausgehender Netzwerkzugriff ist kein Authoring-Feld: Ein Plugin erreicht zur Build-Zeit nie das Netzwerk (die Ahead-of-Time-Grenze), daher gibt es hier kein Host-Allowlist-Feld zu verfassen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
maxMemoryPages | integer | nein | Begrenzt den linearen Speicher des Plugin in Wasm-Seiten (64 KiB pro Seite). Null oder ein fehlender Wert wendet die Standardobergrenze der Plattform an, sodass ein Ladevorgang nie unbegrenzt ist; eine Anbindung, die mehr braucht, erhöht diesen Wert. Minimum: 0. |
timeoutMs | integer | nein | Begrenzt, wie lange der eigene Code des Plugin während eines Aufrufs laufen darf, in Millisekunden, ohne die Zeit innerhalb der Host-Funktionen, die es aufruft. Unter Linux wird Prozessorzeit gemessen, sodass die Wartezeit auf einen Prozessor auf einer ausgelasteten Maschine nicht zählt; auf anderen Systemen ist es die verstrichene Zeit. Der erste Aufruf eines frisch geladenen Plugin zählt auch den eigenen Start des Plugin mit. Null oder ein fehlender Wert wendet die Standardobergrenze der Plattform an, sodass ein Aufruf nie unabbrechbar ist; eine Anbindung, die länger läuft, erhöht diesen Wert. Minimum: 0. |
hostFunctions | string[] | nein | Maschinenverwaltet, nicht von Hand verfassen: die Host-Funktionen, die das Plugin importiert, von aggrega plugin sync (oder aggrega plugin gen-catalog) aus dem Import-Abschnitt des .wasm gelesen und hier in kanonischer Form (sortiert, dedupliziert) aufgezeichnet. Die Veröffentlichung leitet sie erneut aus dem Binary ab und lehnt eine Entität ab, deren Aufzeichnung abweicht; der Pull leitet sie erneut ab und prüft sie nochmals. Der Host registriert genau diese abgeleitete Menge und validiert jeden Eintrag gegen die kuratierte Allowlist. |
configKV | Map von string | nein | Plugin-spezifische Konfiguration, die die Runtime dem Plugin beim Start übergibt, als String-zu-String-Schlüssel/Wert-Paare. Einträge behalten die Reihenfolge des Autors bei, sodass der ausgegebene Datensatz über Läufe hinweg byte-identisch ist. Fehlt sie, bleibt die standardmäßige leere Konfiguration der Runtime wirksam. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.exports[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der ABI-Name des Exports — der Name, an den der Host weiterleitet (zum Beispiel render_node, lint_naming, step). Mindestens 1 Zeichen lang. |
operates | string (enum) | nein | Die Pipeline-Operation, die dieser Export ausführt: patch (ein vorhandenes gerendertes Dokument ändern) oder emit (ein neues Dokument hinzufügen). Fehlt sie, wird keine Operation angegeben. Zulässige Werte: "patch", "emit" |
scope | string (enum) | nein | Die Dokumentwurzel, auf der dieser Export arbeitet: own (die eigenen gerenderten Dokumente des Knotens) oder host (die Dokumente der Komponente, an die ein FeatureRecipe mit Komponenten-Geltungsbereich angebunden ist). Fehlt sie, wird kein Geltungsbereich angegeben. Zulässige Werte: "own", "host" |
selector | string | nein | Eine frei formulierte, menschenlesbare Beschreibung dessen, worauf der Export wirkt (zum Beispiel workloads carrying a pod template). Dokumentation für Leser des Katalogs; der Compiler interpretiert sie nicht. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.commands[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Das Befehlsverb, das der Host registriert — das Token aggrega <name>, das ein Operator aufruft, und der Diskriminator, den der Host dem Plugin beim Aufruf übergibt, sodass ein einzelnes Plugin, das mehrere Befehle bereitstellt, danach routet, welcher Befehl aufgerufen wurde. Mindestens 1 Zeichen lang. |
description | string | nein | Der einzeilige Kurzhilfetext des Befehls, angezeigt in der Befehlsübersicht und in der Hilfeausgabe. Nur Dokumentation; der Host reagiert nicht darauf. |
flags | object[] | nein | Die Flags des Befehls in deklarierter Reihenfolge. Jeder Eintrag steuert ein Flag bei, das der Host am Befehl registriert, sodass aggrega help --help, -h und die globalen Flags; der Host prüft dies, wenn er die Befehle des Plugin hinzufügt, und ein Plugin, dessen Deklarationen die Prüfung nicht bestehen, wird mit einer Warnung nicht hinzugefügt. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.commands[].flags[]
| 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 kurze Alias des Flags — die Form -x, die ein Operator statt des langen Namens übergeben kann — als einzelner ASCII-Buchstabe oder einzelne ASCII-Ziffer. Fehlt er, hat das Flag keinen kurzen Alias. Muster: ^[A-Za-z0-9]$. |
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 (enum) | nein | Der Werttyp des Flags — string, bool oder int — und die Art Flag, als die die Hilfe es darstellt. Fehlt er, wird es als String-Flag dargestellt. Zulässige Werte: "string", "bool", "int" |
default | string | nein | Der Standardwert des Flags, wenn der Operator es nicht übergibt, als String angegeben. Bei einem bool- oder int-Flag ist er ein Wert dieses Typs. Fehlt er, deklariert das Flag keinen Standardwert. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider
Der Provider-Socket-Block für ein Plugin mit pluginType: provider: die Fähigkeiten, die es bedient, wie es die Workload-Art aggrega.ai/v1beta1 übersetzt, welche plattformnativen Annotationen es liest, und sein Vertrag für das Render-Verhalten. Nur bei Provider-rendernden Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | string[] | nein | Aus der Selbstauskunft des .wasm des Plugin von aggrega plugin gen-catalog aufgezeichnet, sodass das Plugin die Quelle dieser Liste ist. Ein Autor kann sie vor dem Veröffentlichen einschränken, indem er einen Eintrag entfernt, den diese Entität nicht anbieten soll, und darf keinen hinzufügen, den die Selbstauskunft nicht nennt: Die Veröffentlichung sowie aggrega validate, dem das .wasm des Plugin mit --plugin übergeben wird, lehnen eine Liste ab, die eine Fähigkeit nennt, die die Selbstauskunft nicht nennt. Die Veröffentlichung sendet die Entität wie geschrieben, ohne diese Liste je umzuschreiben, und vermerkt jede Fähigkeit, die die Selbstauskunft nennt und die die Liste auslässt. Die Fähigkeiten, die dieser Provider bedient — Fähigkeitsnamen wie helm oder compose —, deren Ausgabeform er rendert. Ein Provider ist generisch über Artefakte hinweg, die die Ausgabeform einer Fähigkeit teilen, nicht über alle Fähigkeiten hinweg, daher ist die Liste eine ausdrückliche, getestete Kompatibilitätsangabe und keine Absichtserklärung. Einträge behalten die Reihenfolge des Autors bei. Das angeforderte Provider-Ziel eines Recipe wird zu dem Provider-Plugin aufgelöst, dessen Liste dieses Ziel enthält; ein Ziel, das von mehr als einem Provider-Plugin aufgeführt wird, bricht als mehrdeutig ab, sofern nicht die Auswahl plugins.providers der Workspace-Konfiguration angibt, welches Plugin zu verwenden ist. Eine leere oder fehlende Liste deklariert keine Fähigkeitsangabe, sodass das Plugin kein Ziel bedient. |
workloadSchema | string | nein | JSON Schema 2020-12, das dokumentiert, wie dieser Provider die Workload-Art aggrega.ai/v1beta1 in Provider-native Manifeste übersetzt. Wenn vorhanden, unterstützt der Provider Recipes, die einen workload:-Block deklarieren (synthetisierter Modus) — der Provider übersetzt die Workload in Provider-native Manifeste, gestützt auf dieses Schema als Dokumentation/Vertrag. Ob ein workload:-Recipe unterstützt wird, bestimmt die Synthesefähigkeit des gebundenen Provider, nicht das Vorhandensein dieses Feldes: Ein Recipe im synthetisierten Modus, das an einen Provider gebunden ist, der nicht synthetisieren kann, bricht zur Renderzeit deutlich sichtbar ab. Der Katalog der Standardbibliothek deklariert workloadSchema bei synthetisierenden Providern als den dokumentierten Vertrag, der mit dieser Fähigkeit synchron gehalten wird. Das Feld ist der dokumentierte Vertrag: Der Inhalt wird beim Laden zu JSON Schema 2020-12 kompiliert, um seine Wohlgeformtheit zu prüfen, und nichts anderes liest ihn. |
wellKnownAnnotations | object[] | nein | Die Unterstützungsangabe des Provider: die plattformnativen bekannten Annotationsschlüssel (der Namespace aggrega.ai/), die dieser Provider liest, jeweils mit dem Geltungsbereich, in dem er gelesen wird, und dem Verhalten, das angewendet wird, wenn er fehlt. Deklarieren Sie einen Schlüssel nur dort, wo der Provider ihn liest — die veröffentlichte Unterstützungsmatrix wird aus diesen Deklarationen gerendert, sodass ein hier aufgeführter Schlüssel einer ist, von dem ein Autor erwarten kann, dass er die gerenderte Ausgabe im genannten Geltungsbereich ändert. Der Compiler liest die Deklaration auf zwei Arten: Ein scope, der eine Eingabeart nennt, die das eigene contract.inputKinds des Provider nicht beansprucht, widerspricht einer benachbarten Angabe in derselben Entität, und der Build bricht ab und nennt den Schlüssel und den Widerspruch; und ein Build warnt vor einer aggrega.ai/-Annotation, die über diesen Provider ein Rendering erreicht, wenn kein Eintrag sie für irgendeine Eingabeart abdeckt, die dieses Rendering deklariert. Dies ist von der Regel zu unterscheiden, die das Binden eines Wertes unter dem reservierten Präfix aggrega.ai/ regelt. Fehlt sie, wird keine Unterstützungsangabe deklariert, und für diesen Provider wird keine solche Warnung ausgegeben; ein Provider, der keinen dieser Schlüssel liest, deklariert readsNoWellKnownAnnotations statt dieser Liste. Die Einträge sind eine geordnete Liste und behalten die Reihenfolge des Autors bei. |
readsNoWellKnownAnnotations | const true | nein | Deklariert, dass dieser Provider keinen der plattformnativen Annotationsschlüssel im Namespace aggrega.ai/ liest, die Schlüssel, die wellKnownAnnotations sonst aufführen würde: eine Unterstützungsangabe, die keinen Schlüssel abdeckt, was eine Aussage ist, wo das Weglassen sowohl dieses Feldes als auch von wellKnownAnnotations Schweigen ist. Ein Build warnt dann vor jeder aggrega.ai/-Annotation, die über diesen Provider ein Rendering erreicht, und nennt den Schlüssel, den Provider und die Eingabearten, die dieses Rendering deklariert; der Wert wird dennoch unverändert durchgereicht, und der Build bricht nicht ab. Nur true darf geschrieben werden, sodass das Weglassen des Feldes die einzige Art bleibt, nichts zu sagen. Es kann nicht zusammen mit wellKnownAnnotations geschrieben werden: Ein Provider, der einige der Schlüssel liest, führt stattdessen diese dort auf. Konstante: true |
contract | object | nein | Der selbst deklarierte Vertrag des Provider für das Render-Verhalten: die Eingabearten, die er rendert, wie er die Ausgabe pro Knoten einer Dispatch-Gruppe zusammensetzt und unter welchen Verzeichnissen diese Ausgabe liegt, das Template-Begrenzerpaar, das er auf importierte Artefaktdateien anwendet, ob eine einzige geladene Instanz jeden Übergang bedienen darf, ob er Boundary-übergreifende Kanten verdrahtet, ob er Auslassungseinträge beachtet, ob er die Dateien akzeptiert, die ein Recipe zur gemeinsamen Ausgabe seiner Boundary beisteuert, und welche Dateien sein Ökosystem nie neben einer Quelle ausliefert. Er ist der Datensatz zum Veröffentlichungszeitpunkt der Selbstauskunft des Provider-Plugin, die der Host beim Veröffentlichen und beim Laden mit dieser Selbstauskunft abgleicht. Fehlt er, wird kein Vertrag für das Render-Verhalten deklariert, und der Abgleich vergleicht nur die Angaben pro Export. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider.wellKnownAnnotations[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | string | ja | Der plattformnative bekannte Annotationsschlüssel, den der Provider liest (z. B. aggrega.ai/namespace). Liegt unter dem plattformreservierten Annotations-Namespace aggrega.ai/ — den vom Provider gelesenen Plattformdirektiven. Muster: ^aggrega\.ai/.+. |
purpose | string | ja | Was die Annotation steuert — das Render-Verhalten, das sie beeinflusst, wenn sie vorhanden ist. |
defaultBehavior | string | nein | Das Verhalten, das der Provider anwendet, wenn diese Annotation fehlt. |
scope | string (enum)[] | nein | Wo dieser Provider den Schlüssel liest. Die ersten drei Werte sind die Eingabearten eines Recipe und benennen den Render-Pfad, auf dem der Schlüssel gelesen wird — sourced ein vendorter Dateisatz, synthesized eine Workload, die der Provider materialisiert, artifactsStandalone ein Knoten, dessen gesamte Ausgabe aus importierten Artefaktdokumenten besteht. Jeder dieser Werte muss eine Eingabeart sein, die das contract.inputKinds dieses Provider beansprucht; einen zu nennen, den es nicht beansprucht, bricht den Build ab. boundary ist für einen Schlüssel, der einmal pro Boundary statt pro Knoten aufgelöst wird — der Name eines zusammengesetzten Artefakts oder der Platzierungskontext, aus dem eine Boundary-übergreifende Referenz geformt wird —, wobei die Eingabeart keine sinnvolle Achse ist, daher wird er nicht mit contract.inputKinds abgeglichen. Ein Schlüssel, der auf mehr als einem Pfad gelesen wird, führt jeden davon auf. Fehlt er, wird keine Angabe pro Pfad gemacht: Nichts wird geprüft, und der Schlüssel besagt nur, dass der Provider ihn irgendwo liest. Mindestens 1 Eintrag. Kein Eintrag darf zweimal vorkommen. Zulässige Werte für jeden Eintrag: "sourced", "synthesized", "artifactsStandalone", "boundary". |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider.contract
Der selbst deklarierte Vertrag des Provider für das Render-Verhalten: die Eingabearten, die er rendert, wie er die Ausgabe pro Knoten einer Dispatch-Gruppe zusammensetzt und unter welchen Verzeichnissen diese Ausgabe liegt, das Template-Begrenzerpaar, das er auf importierte Artefaktdateien anwendet, ob eine einzige geladene Instanz jeden Übergang bedienen darf, ob er Boundary-übergreifende Kanten verdrahtet, ob er Auslassungseinträge beachtet, ob er die Dateien akzeptiert, die ein Recipe zur gemeinsamen Ausgabe seiner Boundary beisteuert, und welche Dateien sein Ökosystem nie neben einer Quelle ausliefert. Er ist der Datensatz zum Veröffentlichungszeitpunkt der Selbstauskunft des Provider-Plugin, die der Host beim Veröffentlichen und beim Laden mit dieser Selbstauskunft abgleicht. Fehlt er, wird kein Vertrag für das Render-Verhalten deklariert, und der Abgleich vergleicht nur die Angaben pro Export.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
inputKinds | object | nein | Welche der drei Recipe-Eingabearten dieses Plugin rendert: eine Dateimenge mit Quelle, eine synthetisierte Arbeitslast und einen eigenständigen Knoten nur aus Artefakten. Jedes Feld ist eine unabhängige Angabe. |
boundaryAssembly | string (enum) | nein | Wie das Plugin die Render-Ausgabe pro Knoten einer Dispatch-Gruppe kombiniert: none schreibt die Ausgabe jedes Knotens direkt in den Dispatch-Pfad; merge führt die Fragmente pro Knoten zu einem einzigen Dokument zusammen; nest legt die Ausgabe jedes Knotens an ihrer eigenen Position in einer Umbrella-Struktur ab. Fehlt es, trägt es keine Angabe zur Zusammensetzung. Zulässige Werte: "none", "merge", "nest" |
artifactDelimiters | object | nein | Das Go-Template-Begrenzerpaar, das das Plugin auf importierte Artefaktdateien anwendet. Fehlt es, gilt das Standardpaar {{/}}; ein Plugin, dessen Zielsyntax mit diesem Paar kollidiert, deklariert hier ein alternatives Paar. |
assemblyNameAnnotation | object | nein | Die Boundary-Annotation, deren aufgelöster Wert das Artefakt benennt, das das Plugin aus einer Dispatch-Gruppe zusammensetzt. Ein Plugin, das die beitragenden Boundaries einer Gruppe zu einer einzigen benannten Zusammensetzung zusammenführt, deklariert den Annotationsschlüssel, den es liest, und ob sich jede beitragende Boundary auf den aufgelösten Wert dieser Annotation einigen muss. Fehlt es, benennt das Plugin seine Zusammensetzung allein aus dem Dispatch-Pfad. |
reusableInstance | boolesch | nein | Ob eine einzige geladene Plugin-Instanz jeden Render-, Zusammensetzungs- und Validierungsübergang eines Builds bedienen darf statt einer neuen Instanz pro Übergang. Nur dann als true zu deklarieren, wenn das Plugin keinen Zustand über Übergänge hinweg hält — eine reine Funktion seiner Eingabe pro Übergang —, sodass eine einzige Instanz byteidentische Ausgabe erzeugt, ob wiederverwendet oder neu geladen. Fehlt es (false), wird pro Übergang eine neue Instanz geladen, was ein Plugin, das Zustand trägt, konstruktionsbedingt isoliert. |
crossBoundaryLinking | boolesch | nein | Ob das Plugin eine Boundary-übergreifende uses-Kante verdrahtet — eine uses-Kante, deren konsumierendes und konsumiertes Ende in unterschiedliche Dispatch-Gruppen zusammengesetzt werden —, indem es über einen gepaarten Export-Vertrag link_publish/link_resolve Provider-native Querverweis-Verdrahtung ausgibt. Nur dann als true zu deklarieren, wenn das Plugin beide exportiert; eine Angabe, die nicht zum Export-Paar passt, bricht beim Laden ab. Fehlt es (false), wird keine Boundary-übergreifende Verknüpfung deklariert, sodass der Host keinen Verknüpfungsübergang an das Plugin weiterleitet. |
omits | boolesch | nein | Ob der Provider Auslassungseinträge beachtet — Einträge, die gerenderte Einheiten benennen, die aus der Ausgabe eines Knotens auszulassen sind: Er lässt jede Einheit, die ein Eintrag erfasst, aus dem aus, was er rendert, und meldet, wie viele Einheiten jeder Eintrag erfasst hat. Es ist der Datensatz zum Veröffentlichungszeitpunkt der Angabe omits, die die Selbstauskunft des Provider macht, und ein Wert, der von dieser Auskunft abweicht, bricht beim Laden ab. Fehlt es (false), wird keine solche Unterstützung deklariert. |
boundaryArtifacts | boolesch | nein | Ob der Provider die Dateien akzeptiert, die ein Recipe zur gemeinsamen Ausgabe der Boundary beiträgt, in der es gerendert wird, unter spec.boundary.artifacts des Recipe: Der Compiler schreibt jede solche Datei einmal, in das Verzeichnis, das die zusammengesetzte Ausgabe der Boundary enthält, und das Ziel des Provider behandelt sie als Teil dieser Ausgabe. Es ist der Datensatz zum Veröffentlichungszeitpunkt der Angabe boundary_artifacts, die die Selbstauskunft des Provider macht, und ein Wert, der von dieser Auskunft abweicht, bricht beim Laden ab. Fehlt es (false), wird keine solche Unterstützung deklariert, und ein Recipe, das den Block für diesen Provider deklariert, wird abgelehnt, bevor irgendetwas gerendert wird. |
nestSegment | string | nein | Das Verzeichnis, unter dem das Ziel dieses Provider das eigene Unterverzeichnis jedes Beitragenden ablegt, für einen Provider, dessen boundaryAssembly nest ist — charts für ein Umbrella-Chart, modules für ein Root-Modul. Der Compiler verbindet dieses Verzeichnis, den Namen des Beitragenden und den eigenen Pfad jeder Datei. Wird nur für einen verschachtelnden Provider gelesen. Fehlt es, wird das Unterverzeichnis jedes Beitragenden direkt im eigenen Verzeichnis der Boundary abgelegt. Der Wert benennt ein einziges Verzeichnis und nie einen Pfad. |
sourceIgnore | object | nein | Die Dateien, die das Ökosystem dieses Provider nie neben einer Quelle ausliefert, die er rendert, als Ignore-Regeln in gitignore-Syntax — der Datensatz zum Veröffentlichungszeitpunkt der Regeln source_ignore, die seine Selbstauskunft deklariert. Wenn ein Autor ein Recipe oder FeatureRecipe festlegt, dessen Fähigkeit dieser Provider für ihn bedient, werden diese Regeln mit der eigenen .aggregaignore des Autors kombiniert und in der entity.lock neben der Entität aufgezeichnet, zusammen mit dem Namen dieses Plugin, und jede spätere Veröffentlichung, jeder Vergleich und jedes Rendern der lokalen Quelle der Entität wendet die aufgezeichneten Regeln an. Wenn vorhanden, muss es dem entsprechen, was die Selbstauskunft deklariert, und das Laden lehnt ein Plugin ab, dessen Auskunft abweicht; fehlt es, wird nichts angegeben und nichts verglichen. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider.contract.inputKinds
Welche der drei Recipe-Eingabearten dieses Plugin rendert: eine Dateimenge mit Quelle, eine synthetisierte Arbeitslast und einen eigenständigen Knoten nur aus Artefakten. Jedes Feld ist eine unabhängige Angabe.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
sourced | boolesch | nein | Rendert eine Dateimenge mit Quelle (ein Chart, ein Modul, eine Compose-Datei). |
synthesized | boolesch | nein | Rendert eine synthetisierte Arbeitslast in Provider-native Artefakte. |
artifactsStandalone | boolesch | nein | Rendert einen eigenständigen Knoten nur aus Artefakten — einen, der importierte Artefaktdokumente und weder Quelle noch Arbeitslast trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider.contract.artifactDelimiters
Das Go-Template-Begrenzerpaar, das das Plugin auf importierte Artefaktdateien anwendet. Fehlt es, gilt das Standardpaar {{/}}; ein Plugin, dessen Zielsyntax mit diesem Paar kollidiert, deklariert hier ein alternatives Paar.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
left | string | ja | Der öffnende Begrenzer. |
right | string | ja | Der schließende Begrenzer. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.provider.contract.assemblyNameAnnotation
Die Boundary-Annotation, deren aufgelöster Wert das Artefakt benennt, das das Plugin aus einer Dispatch-Gruppe zusammensetzt. Ein Plugin, das die beitragenden Boundaries einer Gruppe zu einer einzigen benannten Zusammensetzung zusammenführt, deklariert den Annotationsschlüssel, den es liest, und ob sich jede beitragende Boundary auf den aufgelösten Wert dieser Annotation einigen muss. Fehlt es, benennt das Plugin seine Zusammensetzung allein aus dem Dispatch-Pfad.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
annotation | string | ja | Der Schlüssel der Boundary-Annotation, aus dem das Plugin den Namen des zusammengesetzten Artefakts liest. |
requireUnique | 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.
plugin.spec.provider.contract.sourceIgnore
Die Dateien, die das Ökosystem dieses Provider nie neben einer Quelle ausliefert, die er rendert, als Ignore-Regeln in gitignore-Syntax — der Datensatz zum Veröffentlichungszeitpunkt der Regeln source_ignore, die seine Selbstauskunft deklariert. Wenn ein Autor ein Recipe oder FeatureRecipe festlegt, dessen Fähigkeit dieser Provider für ihn bedient, werden diese Regeln mit der eigenen .aggregaignore des Autors kombiniert und in der entity.lock neben der Entität aufgezeichnet, zusammen mit dem Namen dieses Plugin, und jede spätere Veröffentlichung, jeder Vergleich und jedes Rendern der lokalen Quelle der Entität wendet die aufgezeichneten Regeln an. Wenn vorhanden, muss es dem entsprechen, was die Selbstauskunft deklariert, und das Laden lehnt ein Plugin ab, dessen Auskunft abweicht; fehlt es, wird nichts angegeben und nichts verglichen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
patterns | string[] | nein | Die eigenen Ignore-Muster des Ökosystems, jeweils auf das Stammverzeichnis des lokalen Quellverzeichnisses bezogen, in der Reihenfolge, in der sie gelten. |
files | string[] | nein | Die Namen der Ignore-Dateien, die das Ökosystem innerhalb einer Quelle berücksichtigt — .helmignore für ein Chart. Die Zeilen jeder solchen Datei sind weitere Muster, bezogen auf das Verzeichnis, das sie enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.pipelineStep
Der Pipeline-Step-Block für ein Plugin mit pluginType: pipeline-step: die Provider-Fähigkeiten, mit denen sein Schritt kompatibel ist. Nur bei Pipeline-Step-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | string[] | nein | Aus der Selbstauskunft des .wasm des Plugin von aggrega plugin gen-catalog aufgezeichnet, sodass das Plugin die Quelle dieser Liste ist. Ein Autor kann sie vor dem Veröffentlichen einschränken, indem er einen Eintrag entfernt, den diese Entität nicht anbieten soll, und darf keinen hinzufügen, den die Selbstauskunft nicht nennt: Die Veröffentlichung sowie aggrega validate, dem das .wasm des Plugin mit --plugin übergeben wird, lehnen eine Liste ab, die eine Fähigkeit nennt, die die Selbstauskunft nicht nennt. Die Veröffentlichung sendet die Entität wie geschrieben, ohne diese Liste je umzuschreiben, und vermerkt jede Fähigkeit, die die Selbstauskunft nennt und die die Liste auslässt. Die Provider-Fähigkeiten, mit denen der Pipeline-Schritt dieses Plugin kompatibel ist — die Namen von Provider-Fähigkeiten wie helm oder compose, deren gerenderte Ausgabe der Schritt zu transformieren weiß. Ein Schritt wird jeweils gegen die Ausgabeform eines einzigen Provider geschrieben, daher ist die Liste eine ausdrückliche, getestete Kompatibilitätsangabe und keine Absichtserklärung. Einträge behalten die Reihenfolge des Autors bei. Sie ist der im Katalog lesbare Datensatz dieser Angabe; der Build liest dieselbe Angabe aus dem Plugin, wenn ein Schritt einen Geltungsbereich berührt, und bricht ab, wenn der Provider, der die Dokumente dieses Geltungsbereichs rendert, nicht darunter ist. Eine leere oder fehlende Liste deklariert keine Kompatibilitätsangabe, sodass kein Geltungsbereich den Schritt zulässt. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.parser
Der Parser-Block für ein Plugin mit pluginType: parser: die Quellformate, die es in einen kanonischen strukturierten Baum umwandelt. Nur bei Parser-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | string[] | nein | Aus der Selbstauskunft des .wasm des Plugin von aggrega plugin gen-catalog aufgezeichnet, sodass das Plugin die Quelle dieser Liste ist. Ein Autor kann sie vor dem Veröffentlichen einschränken, indem er einen Eintrag entfernt, den diese Entität nicht anbieten soll, und darf keinen hinzufügen, den die Selbstauskunft nicht nennt: Die Veröffentlichung sowie aggrega validate, dem das .wasm des Plugin mit --plugin übergeben wird, lehnen eine Liste ab, die eine Fähigkeit nennt, die die Selbstauskunft nicht nennt. Die Veröffentlichung sendet die Entität wie geschrieben, ohne diese Liste je umzuschreiben, und vermerkt jede Fähigkeit, die die Selbstauskunft nennt und die die Liste auslässt. Die Quellformate, die dieser Parser in einen kanonischen strukturierten Baum umwandelt, jeweils als parse:<format> geschrieben — zum Beispiel parse:yaml. Das Präfix ist Teil des Eintrags, daher listet ein Plugin, das mehrere Formate ausweist, einen Eintrag pro Format. Einträge behalten die Reihenfolge des Autors bei. Ein angefordertes Format wird zu dem Parser aufgelöst, dessen Liste den passenden Eintrag enthält; ein Format, das kein Parser ausweist, bricht den Build ab, und ein Format, das mehr als ein Parser-Plugin ausweist, bricht als mehrdeutig ab. Eine leere oder fehlende Liste deklariert keine Formatangabe, sodass das Plugin nichts parst. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.importer
Der Importer-Block für ein Plugin mit pluginType: importer: die fremden Quellformate, die es in Entwürfe von Aggrega-Authoring-Dateien umwandelt, und die Signaturen, an denen eine Quelle dieser Formate erkannt wird. Nur bei Importer-Plugins vorhanden; fehlt bei jedem anderen Plugin-Typ.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | string[] | nein | Aus der Selbstauskunft des .wasm des Plugin von aggrega plugin gen-catalog aufgezeichnet, sodass das Plugin die Quelle dieser Liste ist. Ein Autor kann sie vor dem Veröffentlichen einschränken, indem er einen Eintrag entfernt, den diese Entität nicht anbieten soll, und darf keinen hinzufügen, den die Selbstauskunft nicht nennt: Die Veröffentlichung sowie aggrega validate, dem das .wasm des Plugin mit --plugin übergeben wird, lehnen eine Liste ab, die eine Fähigkeit nennt, die die Selbstauskunft nicht nennt. Die Veröffentlichung sendet die Entität wie geschrieben, ohne diese Liste je umzuschreiben, und vermerkt jede Fähigkeit, die die Selbstauskunft nennt und die die Liste auslässt. Die fremden Quellformate, die dieser Importer in Entwürfe von Aggrega-Authoring-Dateien umwandelt, jeweils als import:<format> geschrieben — zum Beispiel import:terraform. Das Präfix ist Teil des Eintrags, daher listet ein Plugin, das mehrere Formate ausweist, einen Eintrag pro Format. Einträge behalten die Reihenfolge des Autors bei. Ein angefordertes Importformat wird zu dem Importer aufgelöst, dessen Liste den passenden Eintrag enthält; ein Format, das kein Importer ausweist, bricht den Import ab, und ein Format, das mehr als ein Importer-Plugin ausweist, bricht als mehrdeutig ab, sofern nicht ein Eintrag plugins.importer in der Workspace-Konfiguration eines davon anbindet, das dann ausgeführt wird. Eine leere oder fehlende Liste deklariert keine Formatangabe, sodass das Plugin nichts importiert. |
detect | object[] | nein | Maschinenverwaltet, nicht von Hand verfassen: abgeleitet aus der Selbstauskunft des .wasm des Plugin, wenn die Entität daraus erzeugt wird, und hier in der Reihenfolge aufgezeichnet, in der die Selbstauskunft sie deklariert. Die Signaturen, an denen eine Quelle der Formate dieses Importers erkannt wird, wenn ein Import kein Format nennt. aggrega import liest die Signaturen jedes Importers, den der Katalog des Workspace enthält, jede Version eingeschlossen, sowie der Kern-Importer des Compilers, gleicht sie 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 von mehr als einem Format passen, wird unter Nennung dieser Formate abgelehnt. Ein Importer, der eine Quelle erkennt, erkennt sie als jedes Format, das er ausweist, sodass bei einem Importer, der mehr als ein Format ausweist, jeder Treffer als mehrdeutig abgelehnt wird. Wenn vorhanden, muss die Liste dem entsprechen, was die Selbstauskunft des Plugin deklariert, Eintrag für Eintrag und in derselben Reihenfolge, und das Laden und die Veröffentlichung lehnen ein Plugin ab, dessen Auskunft abweicht, und nennen dabei dieses Feld. Fehlt sie, wird nichts angegeben und nichts verglichen, und die Formate des Importers sind dann nur erreichbar, indem man sie nennt. |
Zusätzliche Eigenschaften sind nicht zulässig.
plugin.spec.importer.detect[]
| 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:<syntax> ausweist. Die Quelle wird mit dem Parser geparst, den der Katalog des Workspace für diese Syntax anbietet, oder, für eine Syntax, für die der Katalog keinen anbietet, mit dem, den der Compiler mitbringt, höchstens einmal, unabhängig davon, wie viele Signaturen die Syntax nennen, und eine Quelle, die sich darin nicht parsen lässt, passt zu keiner Signatur, die sie nennt. Eine Syntax, für die keiner von beiden einen Parser anbietet, beendet die Erkennung und nennt das Fehlen dieses Parsers. Mindestens 1 Zeichen lang. |
files | string[] | nein | Die Dateinamensmuster, für die die Signatur gilt, abgeglichen mit dem Ende des Namens der Quelle, wobei ihre Trennzeichen als Schrägstriche gelesen werden: ein Muster aus einem Segment mit dem eigenen Namen der Datei 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 gilt, wenn irgendein Muster passt. Fehlt es oder ist es leer, gilt sie für eine Quelle, die aus einer einzigen Datei besteht, wie auch immer diese heißt, und für keine Datei eines Verzeichnisses. Die Muster der Signaturen eines Importers entscheiden auch darüber, welche Dateien eines Verzeichnisses aggrega import an ihn übergibt. |
match | object[] | 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.
plugin.spec.importer.detect[].match[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Wo im Baum das Prädikat nachsieht, geschrieben als durch Punkte verbundene Schlüssel von der Spitze des Baums aus: data.nodes benennt das Element 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 Typ des ersten Knotens benennt; jedes andere Segment wählt ein Element eines Objekts. 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 | Ein String, dem der Wert, den der Pfad erreicht, genau entsprechen muss; ein Wert, der kein String ist, entspricht ihm nie. Höchstens eines von equals und prefix wird an einem Prädikat deklariert. Mindestens 1 Zeichen lang. |
prefix | string | nein | Ein String, mit dem der Wert, den der Pfad erreicht, beginnen muss; ein Wert, der kein String ist, beginnt nie damit. Höchstens eines von equals und prefix wird an einem Prädikat deklariert. Mindestens 1 Zeichen lang. |
Zusätzliche Eigenschaften sind nicht zulässig.