Schéma du diagnostic partagé des plugins Wasm 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-diagnostic-v1beta1.schema.json
L’unique forme de diagnostic que partagent tous les sockets Wasm. Un plugin indique une entrée par problème qu’il soulève ; l’hôte la présente. La forme est un sur-ensemble : chaque socket renseigne le sous-ensemble qu’il utilise et omet le reste, de sorte qu’un diagnostic issu de n’importe quel socket est une structure uniforme. severity est l’une de trois valeurs que partagent tous les sockets — halt, warn ou info — de sorte qu’un diagnostic porte le même sens quel que soit le socket qui l’a soulevé.
Type de premier niveau : object
Définitions
Diagnostic
Un problème soulevé par un émetteur de diagnostics : une sévérité, un message lisible par un humain, un emplacement facultatif et des champs facultatifs propres à l’émetteur. Un émetteur est un socket de plugin Wasm ou le compilateur lui-même — tous deux rendent compte selon cette forme unique, de sorte qu’un lecteur interprète une entrée de la même manière quel que soit celui qui l’a soulevée. Chacun renseigne le sous-ensemble qu’il utilise et omet le reste : un parser définit un span de location, une importation définit code et source_ref, un linter de publication définit rule_id et classification, un verdict de gouvernance définit la severity et le message de l’issue du build et peut ajouter n’importe lesquels de code, rule_id, classification, source_ref, location et suggest, et un avertissement de rendu définit code, source_ref et une location structurée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
severity | string (enum) | oui | La sévérité du diagnostic, tirée d’un ensemble fermé unique que partagent tous les sockets. halt arrête le build et nomme ce qu’il faut corriger. warn est présenté à côté d’un build qui se termine malgré tout. info enregistre l’observation et laisse l’issue du build inchangée. Chaque émetteur rend compte à partir de cet ensemble unique, de sorte qu’un lecteur interprète une sévérité de la même manière quel que soit celui qui l’a soulevée. Valeurs autorisées : "halt", "warn", "info" |
message | string | oui | Le texte du diagnostic lisible par un humain. |
code | string | non | Un code facultatif, stable et comparable par une machine pour le diagnostic, indépendant du message lisible par un humain. Absent lorsque l’émetteur n’attribue aucun code. Un code peut provenir d’un socket de plugin ou des propres avertissements du compilateur, qui en définissent un sur chaque entrée qu’ils soulèvent. |
rule_id | string | non | L’identifiant de la règle qui a produit le diagnostic, lorsque l’émetteur est fondé sur des règles (un linter de publication). Absent sinon. |
classification | string (enum) | non | Une classification de l’impact sur la version sémantique que porte le diagnostic, lorsque la règle émettrice en attribue une (une règle d’évolution de schéma). Absente pour les diagnostics qui ne portent aucune classification. Valeurs autorisées : "PATCH", "MINOR", "MAJOR" |
source_ref | string | non | Une référence opaque à l’élément source que concerne le diagnostic (par exemple l’identifiant d’un nœud source qu’une importation n’a pas pu résoudre). Absente lorsque le diagnostic ne fait référence à aucun élément source précis. |
location | Location | non | L’endroit où pointe le diagnostic, lorsque l’émetteur peut localiser le problème. Un parser renseigne la plage d’octets ; un moteur de rendu renseigne la position structurée dans un document source. Absent lorsque le diagnostic n’a aucun emplacement. |
suggest | string | non | Une indication de correction facultative que l’émetteur propose à côté du diagnostic. Absente lorsqu’aucune indication n’est proposée. |
Les propriétés supplémentaires ne sont pas autorisées.
Location
L’endroit où pointe un diagnostic. Il porte un localisateur unifié unique qui sert à la fois une position précise à l’octet dans le texte source brut (un parser renseigne span) et une position structurée dans un document source (un moteur de rendu renseigne key_path, uri, line et kind), et nomme l’instance du build que concerne le diagnostic lorsqu’il y en a une (instance). Chaque champ est facultatif ; un socket renseigne la représentation qu’il peut produire et omet le reste.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
span | Span | non | La plage d’octets sources bruts que le diagnostic localise, lorsque l’émetteur analyse la source et peut circonscrire le problème à une plage d’octets (un parser). Absente sinon. |
key_path | string | non | Un chemin à points vers l’élément fautif dans un document source structuré, lorsque l’émetteur localise le problème de manière structurelle (un moteur de rendu). Absent sinon. |
uri | string | non | Un identifiant de l’artefact source que concerne le diagnostic, lorsque l’émetteur le connaît (un moteur de rendu). Absent sinon. Il ne nomme jamais une instance du build ; c’est instance qui la porte. |
line | integer | non | Un numéro de ligne dans le document source structuré, distinct de la ligne et de la colonne en octets bruts que porte span. Présent lorsque l’émetteur connaît une ligne du document (un moteur de rendu). Absent sinon. |
kind | string | non | Une chaîne ouverte qui nomme la surface source à laquelle se rapporte l’emplacement, lorsque l’émetteur distingue des surfaces (un moteur de rendu). Absente sinon. |
instance | string | non | L’instance du build que concerne le diagnostic, désignée par l’identité que lui donne le build : un composant par le nom sous lequel l’Aggregate le déclare, un composant qu’apporte un module par son chemin pointé à travers le module, un composant que dérive le build par l’identité que le build compose pour lui, et un module par son propre chemin. Présent lorsque le diagnostic porte sur une instance ; absent sinon. |
Les propriétés supplémentaires ne sont pas autorisées.
Span
Une plage des octets de la source d’origine : les décalages en octets sont l’emplacement principal et exact, et les numéros de ligne et de colonne les accompagnent pour des diagnostics lisibles par un humain.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
start_offset | integer | oui | Le décalage en octets du premier octet de la plage dans la source d’origine, à partir de zéro. |
end_offset | integer | oui | Le décalage en octets situé un octet après le dernier octet de la plage dans la source d’origine, de sorte que end_offset moins start_offset est la longueur de la plage en octets. |
start_line | integer | oui | Le numéro de ligne du début de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
start_column | integer | oui | Le numéro de colonne du début de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
end_line | integer | oui | Le numéro de ligne de la fin de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
end_column | integer | oui | Le numéro de colonne de la fin de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
Les propriétés supplémentaires ne sont pas autorisées.