Schéma du socket Wasm de linter d’Aggrega
Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.
Identifiant du schéma : https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json
Les formes de transmission que le socket de linter consomme (LinterInput) et émet (LinterOutput). Le linter s’exécute au moment de la publication sur une paire d’entités version précédente + version proposée (la règle d’évolution du schéma) et au moment de la vérification des conventions de l’espace de travail sur des entités individuelles (règles structurelles par règle). Un seul plugin Wasm livré héberge de nombreuses règles ; le plugin sélectionne la règle à exécuter au moyen de LinterInput.rule_id. Ce schéma est la source unique des deux formes de transmission : les types de payload Go, Rust et TypeScript en sont générés dans le paquet partagé de l’ABI des plugins, et chaque kit de plugin réexporte ces types générés au lieu de déclarer sa propre copie.
L’une des formes suivantes
LinterInputLinterOutput
Définitions
LinterInput
Le payload que l’hôte remet au plugin de linter de publication à chaque invocation. rule_id sélectionne la règle vers laquelle le plugin distribue. entity_kind identifie le type d’entité soumis au lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed porte la structure analysée de l’entité en cours de classification (l’hôte analyse le YAML en JSON avant l’envoi ; le plugin ne voit jamais d’octets bruts). previous porte l’entité analysée de la version précédente pour la règle d’évolution du schéma ; omis lorsqu’il ne s’applique pas. implemented_component porte une entité liée d’un type différent — le Component qu’une Recipe soumise au lint réalise — pour les règles qui comparent une entité à un contrat qu’une autre entité déclare ; omis lorsqu’il ne s’applique pas. release et components portent le reste d’une Release pour une règle qui en lit une en entier — proposed est alors l’Aggregate que la Release déploie, release cette Release, et components le Component dont chacune des instances de composant de l’Aggregate est une instance ; les deux sont omis sur toute autre entrée. policies porte la configuration de la discipline de publication par espace de travail que la règle consulte.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
rule_id | string | oui | La règle vers laquelle le plugin doit distribuer, nommée par son identifiant de règle — le même identifiant en kebab-case que le constat résultant porte dans rule_id, de sorte qu’une règle supprimée ou signalée est nommée de la même manière sur chaque surface. L’ensemble reconnu est celui vers lequel le plugin livré distribue ; un identifiant de règle que le plugin ne reconnaît pas produit un constat ‘unknown_rule’ plutôt qu’une réussite silencieuse. |
entity_kind | string (enum) | oui | Le type d’entité que les valeurs proposed/previous encodent. La classification de la règle d’évolution du schéma varie selon le type ; les règles structurelles se limitent à des types précis. Valeurs autorisées : "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate" |
proposed | object | oui | Structure analysée de l’entité en cours de classification. L’hôte convertit le YAML en JSON avant l’envoi, de sorte que le plugin reçoit une valeur déjà structurée et ne voit jamais d’octets bruts. Sur l’entrée d’une règle qui lit une Release entière, il s’agit de l’Aggregate que cette Release déploie. Sur chaque entrée, chaque valeur de paramètre est retirée avant que l’entité soit remise, car la valeur d’un paramètre peut être l’information d’identification elle-même, de sorte qu’aucune valeur de paramètre n’atteint un plugin linter par ce champ. Un Aggregate conserve ses déclarations spec.parameters, chacune ne contenant que les clés que le schéma de l’Aggregate admet sur une déclaration de paramètre autres que default, et il en va de même pour chaque déclaration imbriquée sous properties, items et valuesType : une valeur par défaut est retirée plutôt que remplacée, de sorte qu’un plugin ne peut pas savoir si une déclaration en donne une, et une clé que le schéma n’admet pas à cet endroit est retirée avec tout ce qu’elle contient. Le bloc parameters de chaque module sous spec.aggregates, qui porte les valeurs passées à ce module, est retiré en entier, tout comme spec.parameters sur une entité de tout autre type. Le texte de template qui lit un paramètre est conservé tel qu’il est écrit. |
previous | object | non | Structure analysée de l’entité de la version précédente, pour les règles qui effectuent une comparaison par paires (évolution du schéma), avec ses valeurs de paramètres retirées exactement comme elles le sont de proposed. Omise lorsque la règle n’a pas besoin d’une référence à la version précédente (par exemple, première publication, règles uniquement structurelles). |
implemented_component | object | non | Structure analysée du Component qu’une Recipe soumise au lint nomme dans spec.implements, résolu par l’hôte. Il s’agit d’une entité liée d’un type DIFFÉRENT de celle soumise au lint, ce qui la distingue de previous : previous porte une autre version de la même entité, tandis que ce champ porte le Component dont la Recipe réalise le contrat de sortie déclaré. L’hôte le résout par la même recherche dans le catalogue qu’utilise un build, indexée sur le nom du Component, de sorte que les trois formes d’épinglage qu’accepte spec.implements (sans version, exacte, plage compatible avec la version majeure) atteignent la même entrée. Omise lorsque l’entité soumise au lint n’est pas une Recipe, lorsqu’elle ne nomme aucun Component ou lorsqu’aucun Component de ce nom n’est accessible dans les répertoires de catalogue de l’espace de travail. Une valeur absente signifie que la comparaison n’est pas disponible, et non que le contrat est vide : une règle qui lit ce champ n’émet aucun constat lorsqu’il est absent. |
release | object | non | Structure analysée de la Release qu’un lint de portée release nomme, avec sa chaîne extends intégrée, de sorte qu’une Release enfant porte ce qu’elle hérite de sa base. L’hôte la convertit de YAML en JSON comme il le fait pour proposed. Son bloc spec.parameters contient les valeurs qui satisfont les paramètres de l’Aggregate, il est donc retiré en entier avant que la Release soit remise : la valeur d’un paramètre peut être l’information d’identification elle-même, aucune règle ne lit le bloc, et ainsi aucune valeur de paramètre n’atteint un plugin linter par ce champ. Présente uniquement sur l’entrée d’une règle qui lit une Release entière, où proposed est l’Aggregate que cette Release déploie, avec ses valeurs de paramètres retirées comme le décrit proposed ; omise sur toute autre entrée. |
components | map de object | non | Le Component dont chaque instance de composant de l’Aggregate est une instance, indexé par le nom d’instance que l’Aggregate lui donne, qui est la même clé qu’utilisent les maps components propres de l’Aggregate et de la Release. Chaque valeur est le Component vers lequel se résout le type de l’instance, avec toute chaîne extends intégrée, converti en JSON comme l’est implemented_component. Une instance dont le Component n’est pas accessible dans les répertoires de catalogue de l’espace de travail est absente, et une règle lit cette absence comme une indisponibilité plutôt que comme un Component qui ne déclare rien. Présent uniquement à côté de release, sur l’entrée d’une règle qui lit une Release entière ; omis sur toute autre entrée. |
source_path | string | non | Chemin du système de fichiers depuis lequel l’entité a été chargée. Renseigné par les appelants hôtes qui parcourent le système de fichiers du catalogue ; consommé par les règles sensibles au chemin (par exemple category-matches-directory). Omis lorsque l’appelant n’a pas de contexte de chemin. |
policies | Policies | non | La configuration de la discipline de publication par espace de travail que la règle consulte, portée sous la forme d’un objet Policies que l’hôte assemble à partir de la configuration de l’espace de travail et d’éventuelles surcharges en ligne de commande. |
Les propriétés supplémentaires ne sont pas autorisées.
LinterOutput
La forme de réponse qu’émet le plugin de linter de publication. findings porte une entrée par invocation de règle ayant produit un résultat. La règle d’évolution du schéma émet exactement un constat (le verdict de classification) ; les règles structurelles peuvent en émettre zéro (aucune violation) ou plusieurs (un par infraction).
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
findings | Diagnostic[] | oui | Constats par règle produits par l’invocation du plugin, dans l’ordre d’émission du plugin. |
error | string | non | Un message d’échec défini lorsque l’invité s’est exécuté mais n’a pas pu terminer l’opération ; absent en cas de succès. Il est distinct des éventuels diagnostics que porte la sortie : les diagnostics signalent des problèmes trouvés pendant une exécution qui a malgré tout produit un résultat, tandis que error signale que l’opération elle-même ne s’est pas terminée. L’hôte présente une erreur présente comme une invocation de plugin échouée. |
Les propriétés supplémentaires ne sont pas autorisées.
Policies
Configuration de la discipline de publication par espace de travail que l’ensemble de règles consulte, assemblée par l’hôte à partir des réglages de discipline de publication de la configuration de l’espace de travail et d’éventuelles surcharges en ligne de commande. Ce schéma est le contrat de la forme. L’omission d’un champ donne à chaque indicateur la valeur par défaut false, et l’hôte n’écrit que les champs dont la valeur n’est pas celle par défaut.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
allow_dynamic_refs | booléen | non | Si true, l’utilisation de $dynamicAnchor / $dynamicRef dans les entrées de SchemaLibrary est autorisée (supprime la règle dynamic-refs). Valeur par défaut : false. |
allow_id_overrides | booléen | non | Si true, les surcharges de $id dans les entrées de SchemaLibrary sont autorisées (supprime la règle id-overrides). Valeur par défaut : false. |
allow_direct_x_aggrega_extensions | booléen | non | Si true, la rédaction directe de x-aggrega-selector / x-aggrega-inject est autorisée (supprime la règle x-aggrega-discouragement). Valeur par défaut : false. |
allow_aggrega_ai_prefix | booléen | non | Si true, la règle annotation-prefix est entièrement supprimée (à la fois la vérification du simple aggrega.ai/ et la vérification de feature.aggrega.ai/ conditionnée au type). Valeur par défaut : false. |
allow_nonstandard_names | booléen | non | Si true, les violations de la forme du nom sont autorisées (supprime la règle name-shape). Valeur par défaut : false. |
allow_category_mismatches | booléen | non | Si true, supprime les constats de la règle category-matches-directory. La convention du catalogue standard exige que les Components sous core/ |
allow_undeclared_recipe_provides | booléen | non | Si true, supprime les constats de la règle provides-declared-by-component. Cette règle signale chaque clé qu’une Recipe publie dans spec.provides et que le Component nommé par son spec.implements ne déclare pas dans le pilier provides de son spec.schema. Publier au-delà du contrat déclaré est accepté au moment du build, le constat est donc un avertissement ; un espace de travail dont les Recipes publient délibérément des clés que leur Component ne déclare pas s’en exempte ici. Valeur par défaut : false. |
allow_connection_credential_mismatches | booléen | non | Si true, supprime les constats de la règle connection-credential-matches-target-key. Cette règle lit une Release entière et compare, pour chaque connexion dont la cible déclare la clé qu’elle exige de ses appelants, l’information d’identification que présente la connexion avec la clé que détient la cible : elle signale deux extrémités qui nomment des secrets différents, ainsi qu’une clé déclarée à une seule extrémité. L’accord entre les deux extrémités est une convention du catalogue plutôt qu’une chose qu’un build vérifie, le constat est donc un avertissement ; un espace de travail dont les deux extrémités diffèrent délibérément s’en exempte ici. Valeur par défaut : false. |
Les propriétés supplémentaires ne sont pas autorisées.