Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für den Wasm-Linter-Socket

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json

Die Übertragungsformen, die der Linter-Socket konsumiert (LinterInput) und ausgibt (LinterOutput). Der Linter läuft zur Veröffentlichungszeit über ein Entitätspaar aus vorheriger und vorgeschlagener Version (die Regel zur Schema-Evolution) und zur Zeit der Konventionsprüfung des Workspace über einzelne Entitäten (strukturelle Regeln pro Regel). Ein ausgeliefertes Wasm-Plugin beherbergt viele Regeln; das Plugin wählt über LinterInput.rule_id aus, welche Regel ausgeführt wird. Dieses Schema ist die einzige Quelle beider Übertragungsformen: Die Payload-Typen für Go, Rust und TypeScript werden daraus in das gemeinsame Plugin-ABI-Paket generiert, und jedes Plugin-Kit re-exportiert diese generierten Typen, statt eine eigene Kopie zu deklarieren.

Eine der folgenden Formen

  • LinterInput
  • LinterOutput

Definitionen

LinterInput

Die Payload, die der Host dem Veröffentlichungs-Linter-Plugin bei jedem Aufruf übergibt. rule_id wählt aus, an welche Regel das Plugin dispatcht. entity_kind identifiziert die Entitätsart, die gelintet wird (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed trägt die geparste Entitätsstruktur, die klassifiziert wird (der Host parst YAML vor dem Senden zu JSON; das Plugin sieht nie rohe Bytes). previous trägt die geparste Entität der vorherigen Version für die Regel zur Schema-Evolution; weggelassen, wenn nicht zutreffend. implemented_component trägt eine verwandte Entität einer anderen Art — die Component, die ein gelintetes Recipe realisiert — für Regeln, die eine Entität mit einem Vertrag vergleichen, den eine andere Entität deklariert; weggelassen, wenn nicht zutreffend. release und components tragen den Rest eines Release für eine Regel, die eines als Ganzes liest — proposed ist dann das Aggregate, das das Release bereitstellt, release dieses Release und components die Component, von der jede der Komponenteninstanzen des Aggregate eine Instanz ist; beide werden bei jeder anderen Eingabe weggelassen. policies trägt die Konfiguration der Veröffentlichungsdisziplin pro Workspace, die die Regel heranzieht.

EigenschaftTypErforderlichBeschreibung
rule_idstringjaDie Regel, an die das Plugin dispatchen soll, benannt über ihre Regel-ID — dieselbe Kennung in kebab-case, die der resultierende Befund in rule_id trägt, sodass eine unterdrückte oder gemeldete Regel auf jeder Oberfläche gleich benannt wird. Die erkannte Menge ist das, was das ausgelieferte Plugin dispatcht; eine Regel-ID, die das Plugin nicht erkennt, erzeugt einen Befund ‘unknown_rule’ statt eines stillen Bestehens.
entity_kindstring (enum)jaDie Entitätsart, die die Werte proposed/previous kodieren. Die Klassifizierung der Regel zur Schema-Evolution variiert je nach Art; strukturelle Regeln beschränken sich auf bestimmte Arten. Zulässige Werte: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectjaGeparste Struktur der Entität, die klassifiziert wird. Der Host konvertiert YAML vor dem Senden in JSON, sodass das Plugin einen bereits strukturierten Wert erhält und nie rohe Bytes sieht. Bei der Eingabe einer Regel, die ein ganzes Release liest, ist es das Aggregate, das dieses Release bereitstellt. Bei jeder Eingabe wird jeder Parameterwert entfernt, bevor die Entität übergeben wird, weil der Wert eines Parameters selbst die Zugangsdaten sein kann, sodass kein Parameterwert über dieses Feld ein Linter-Plugin erreicht. Ein Aggregate behält seine spec.parameters-Deklarationen, jede nur mit den Schlüsseln, die das Aggregate-Schema für eine Parameterdeklaration zulässt, außer default, und für jede unter properties, items und valuesType verschachtelte Deklaration gilt dasselbe: Ein Standardwert wird entfernt statt ersetzt, sodass ein Plugin nicht erkennen kann, ob eine Deklaration einen angibt, und ein Schlüssel, den das Schema dort nicht zulässt, wird mit allem, was er enthält, entfernt. Der parameters-Block jedes Moduls unter spec.aggregates, der die an dieses Modul übergebenen Werte trägt, wird als Ganzes entfernt, ebenso spec.parameters bei einer Entität jeder anderen Art. Template-Text, der einen Parameter liest, bleibt wie geschrieben erhalten.
previousobjectneinGeparste Struktur der Entität der vorherigen Version, für Regeln, die einen paarweisen Vergleich durchführen (Schema-Evolution), wobei ihre Parameterwerte genau so entfernt sind wie bei proposed. Weggelassen, wenn die Regel keinen Verweis auf eine vorherige Version benötigt (z. B. bei der ersten Veröffentlichung oder bei rein strukturellen Regeln).
implemented_componentobjectneinGeparste Struktur der Component, die ein gelintetes Recipe in spec.implements nennt, vom Host aufgelöst. Sie ist eine verwandte Entität einer ANDEREN Art als die gelintete, und genau das unterscheidet sie von previous: previous trägt eine andere Version derselben Entität, während dieses Feld die Component trägt, deren deklarierten Ausgabevertrag das Recipe realisiert. Der Host löst sie über dieselbe Katalogsuche auf, die ein Build verwendet, mit dem Namen der Component als Schlüssel, sodass alle drei Pin-Formen, die spec.implements akzeptiert (unversioniert, exakt, major-kompatibler Bereich), denselben Eintrag erreichen. Weggelassen, wenn die gelintete Entität kein Recipe ist, wenn sie keine Component nennt oder wenn keine Component dieses Namens in den Katalogverzeichnissen des Workspace erreichbar ist. Ein fehlender Wert bedeutet, dass der Vergleich nicht verfügbar ist, nicht dass der Vertrag leer ist: Eine Regel, die dieses Feld liest, gibt keinen Befund aus, wenn es fehlt.
releaseobjectneinGeparste Struktur des Release, das ein Lint mit Release-Geltungsbereich nennt, mit eingefalteter extends-Kette, sodass ein untergeordnetes Release trägt, was es von seiner Basis erbt. Der Host konvertiert es von YAML in JSON, wie er es bei proposed tut. Sein spec.parameters-Block enthält die Werte, die die Parameter des Aggregate erfüllen, daher wird er als Ganzes entfernt, bevor das Release übergeben wird: Der Wert eines Parameters kann selbst die Zugangsdaten sein, keine Regel liest den Block, und so erreicht kein Parameterwert über dieses Feld ein Linter-Plugin. Nur bei der Eingabe einer Regel vorhanden, die ein ganzes Release liest, wobei proposed das Aggregate ist, das dieses Release bereitstellt, mit seinen Parameterwerten entfernt, wie proposed es beschreibt; bei jeder anderen Eingabe weggelassen.
componentsMap von objectneinDie Component, von der jede Komponenteninstanz des Aggregate eine Instanz ist, indiziert nach dem Instanznamen, den das Aggregate ihr gibt, was derselbe Schlüssel ist, den die eigenen components-Maps des Aggregate und des Release verwenden. Jeder Wert ist die Component, zu der der Typ der Instanz aufgelöst wird, mit gegebenenfalls eingefalteter extends-Kette, nach JSON konvertiert, wie es implemented_component ist. Eine Instanz, deren Component in den Katalogverzeichnissen des Workspace nicht erreichbar ist, fehlt, und eine Regel liest dieses Fehlen als nicht verfügbar statt als eine Component, die nichts deklariert. Nur neben release vorhanden, bei der Eingabe einer Regel, die ein ganzes Release liest; bei jeder anderen Eingabe weggelassen.
source_pathstringneinDateisystempfad, aus dem die Entität geladen wurde. Befüllt von Host-Aufrufern, die das Katalog-Dateisystem durchlaufen; verwendet von pfadbewussten Regeln (z. B. category-matches-directory). Weggelassen, wenn der Aufrufer keinen Pfadkontext hat.
policiesPoliciesneinDie Konfiguration der Veröffentlichungsdisziplin pro Workspace, die die Regel heranzieht, getragen als ein Policies-Objekt, das der Host aus der Workspace-Konfiguration und etwaigen Überschreibungen über die Befehlszeile zusammensetzt.

Zusätzliche Eigenschaften sind nicht zulässig.

LinterOutput

Die Antwortform, die das Veröffentlichungs-Linter-Plugin ausgibt. findings trägt einen Eintrag pro Regelaufruf, der ein Ergebnis erzeugt hat. Die Regel zur Schema-Evolution gibt genau einen Befund aus (das Klassifizierungsurteil); strukturelle Regeln können null (keine Verstöße) oder viele (einen pro Verstoß) ausgeben.

EigenschaftTypErforderlichBeschreibung
findingsDiagnostic[]jaBefunde pro Regel, die der Plugin-Aufruf erzeugt hat, in der Ausgabereihenfolge des Plugins.
errorstringneinEine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf.

Zusätzliche Eigenschaften sind nicht zulässig.

Policies

Konfiguration der Veröffentlichungsdisziplin pro Workspace, die der Regelsatz heranzieht, vom Host zusammengesetzt aus den Einstellungen zur Veröffentlichungsdisziplin der Workspace-Konfiguration und etwaigen Überschreibungen über die Befehlszeile. Dieses Schema ist der Vertrag für die Form. Das Weglassen eines Felds setzt jedes Flag standardmäßig auf false, und der Host schreibt nur die Felder, deren Wert nicht der Standardwert ist.

EigenschaftTypErforderlichBeschreibung
allow_dynamic_refsbooleschneinWenn true, ist die Verwendung von $dynamicAnchor / $dynamicRef in SchemaLibrary-Einträgen erlaubt (unterdrückt die Regel dynamic-refs). Standardwert: false.
allow_id_overridesbooleschneinWenn true, sind $id-Überschreibungen in SchemaLibrary-Einträgen erlaubt (unterdrückt die Regel id-overrides). Standardwert: false.
allow_direct_x_aggrega_extensionsbooleschneinWenn true, ist das direkte Authoring von x-aggrega-selector / x-aggrega-inject erlaubt (unterdrückt die Regel x-aggrega-discouragement). Standardwert: false.
allow_aggrega_ai_prefixbooleschneinWenn true, wird die Regel annotation-prefix vollständig unterdrückt (sowohl die Prüfung auf das bloße aggrega.ai/ als auch die von der Art abhängige Prüfung auf feature.aggrega.ai/). Standardwert: false.
allow_nonstandard_namesbooleschneinWenn true, sind Verstöße gegen die Namensform erlaubt (unterdrückt die Regel name-shape). Standardwert: false.
allow_category_mismatchesbooleschneinWenn true, werden die Befunde der Regel category-matches-directory unterdrückt. Die Konvention des Standardkatalogs verlangt, dass Components unter core// component.aggrega.ai/category={category} passend zum Verzeichnissegment deklarieren, wobei {category} einer der 15 Werte der geschlossenen Menge ist. Workspaces mit berechtigten dauerhaften Ausnahmen nehmen sich hier aus. Standardwert: false.
allow_undeclared_recipe_providesbooleschneinWenn true, werden die Befunde der Regel provides-declared-by-component unterdrückt. Diese Regel meldet jeden Schlüssel, den ein Recipe in spec.provides veröffentlicht und den die von seinem spec.implements genannte Component nicht in der provides-Säule ihres spec.schema deklariert. Das Veröffentlichen über den deklarierten Vertrag hinaus wird zur Build-Zeit akzeptiert, daher ist der Befund ein Hinweis; ein Workspace, dessen Recipes bewusst Schlüssel veröffentlichen, die ihre Component nicht deklariert, nimmt sich hier aus. Standardwert: false.
allow_connection_credential_mismatchesbooleschneinWenn true, werden die Befunde der Regel connection-credential-matches-target-key unterdrückt. Diese Regel liest ein ganzes Release und vergleicht für jede Verbindung, deren Ziel den Schlüssel deklariert, den es von seinen Aufrufern verlangt, die Zugangsdaten, die die Verbindung vorlegt, mit dem Schlüssel, den das Ziel hält: Sie meldet zwei Enden, die verschiedene Secrets nennen, und einen nur an einem Ende deklarierten Schlüssel. Die Übereinstimmung zwischen den beiden Enden ist eine Katalog-Konvention und nichts, was ein Build prüft, daher ist der Befund ein Hinweis; ein Workspace, dessen beide Enden bewusst voneinander abweichen, nimmt sich hier aus. Standardwert: false.

Zusätzliche Eigenschaften sind nicht zulässig.