Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del socket Wasm de linter de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

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

Las formas de transmisión que consume (LinterInput) y emite (LinterOutput) el socket de linter. El linter se ejecuta en el momento de la publicación sobre un par de entidades versión anterior + versión propuesta (la regla de evolución del esquema) y en el momento de la comprobación de convenciones del espacio de trabajo sobre entidades individuales (reglas estructurales por regla). Un único plugin Wasm distribuido aloja muchas reglas; el plugin selecciona qué regla ejecutar mediante LinterInput.rule_id. Este esquema es la fuente única de ambas formas de transmisión: los tipos de payload de Go, Rust y TypeScript se generan a partir de él en el paquete compartido de la ABI de plugins, y cada kit de plugins reexporta esos tipos generados en lugar de declarar su propia copia.

Una de las siguientes formas

  • LinterInput
  • LinterOutput

Definiciones

LinterInput

El payload que el host entrega al plugin de linter de publicación en cada invocación. rule_id selecciona a qué regla despacha el plugin. entity_kind identifica el tipo de entidad que se somete a lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed lleva la estructura analizada de la entidad que se clasifica (el host analiza el YAML a JSON antes de enviarlo; el plugin nunca ve bytes sin procesar). previous lleva la entidad analizada de la versión anterior para la regla de evolución del esquema; se omite cuando no es aplicable. implemented_component lleva una entidad relacionada de un tipo distinto — el Component que realiza una Recipe sometida a lint — para las reglas que comparan una entidad con un contrato que declara otra entidad; se omite cuando no es aplicable. release y components llevan el resto de una Release para una regla que lee una completa — proposed es entonces el Aggregate que despliega la Release, release esa Release, y components el Component del que cada una de las instancias de componente del Aggregate es una instancia; ambos se omiten en cualquier otra entrada. policies lleva la configuración de la disciplina de publicación por espacio de trabajo que consulta la regla.

PropiedadTipoObligatoriaDescripción
rule_idstringsíLa regla a la que el plugin debe despachar, nombrada por su id de regla — el mismo identificador en kebab-case que el hallazgo resultante lleva en rule_id, de modo que una regla suprimida o informada se nombra de la misma forma en todas las superficies. El conjunto reconocido es aquel al que despacha el plugin distribuido; un id de regla que el plugin no reconoce produce un hallazgo ‘unknown_rule’ en lugar de una aprobación silenciosa.
entity_kindstring (enum)síEl tipo de entidad que codifican los valores proposed/previous. La clasificación de la regla de evolución del esquema varía según el tipo; las reglas estructurales se limitan a tipos concretos. Valores permitidos: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectsíEstructura analizada de la entidad que se clasifica. El host convierte el YAML a JSON antes de enviarlo, de modo que el plugin recibe un valor ya estructurado y nunca ve bytes sin procesar. En la entrada de una regla que lee una Release completa, es el Aggregate que despliega esa Release. En cada entrada se elimina cada valor de parámetro antes de entregar la entidad, porque el valor de un parámetro puede ser la propia credencial, de modo que ningún valor de parámetro llega a un plugin linter a través de este campo. Un Aggregate conserva sus declaraciones spec.parameters, cada una con solo las claves que el esquema del Aggregate admite en una declaración de parámetro distintas de default, y lo mismo se aplica a cada declaración anidada bajo properties, items y valuesType: un valor predeterminado se elimina en lugar de sustituirse, de modo que un plugin no puede saber si una declaración da uno, y una clave que el esquema no admite allí se elimina con todo lo que contiene. El bloque parameters de cada módulo bajo spec.aggregates, que lleva los valores pasados a ese módulo, se elimina por completo, al igual que spec.parameters en una entidad de cualquier otro tipo. El texto de plantilla que lee un parámetro se conserva tal como está escrito.
previousobjectnoEstructura analizada de la entidad de la versión anterior, para las reglas que realizan una comparación por pares (evolución del esquema), con sus valores de parámetros eliminados exactamente como lo están de proposed. Se omite cuando la regla no necesita una referencia a la versión anterior (p. ej., primera publicación, reglas solo estructurales).
implemented_componentobjectnoEstructura analizada del Component que una Recipe sometida a lint nombra en spec.implements, resuelto por el host. Es una entidad relacionada de un tipo DIFERENTE del de la que se somete a lint, que es lo que la distingue de previous: previous lleva otra versión de la misma entidad, mientras que este campo lleva el Component cuyo contrato de salida declarado realiza la Recipe. El host lo resuelve mediante la misma búsqueda en el catálogo que usa un build, con el nombre del Component como clave, de modo que las tres formas de fijación que acepta spec.implements (sin versión, exacta, rango compatible con la versión mayor) llegan a la misma entrada. Se omite cuando la entidad sometida a lint no es una Recipe, cuando no nombra ningún Component o cuando ningún Component con ese nombre es accesible en los directorios de catálogo del espacio de trabajo. Un valor ausente significa que la comparación no está disponible, no que el contrato esté vacío: una regla que lee este campo no emite ningún hallazgo cuando está ausente.
releaseobjectnoEstructura analizada de la Release que nombra un lint con ámbito de release, con su cadena extends incorporada, de modo que una Release hija lleva lo que hereda de su base. El host la convierte de YAML a JSON como hace con proposed. Su bloque spec.parameters contiene los valores que satisfacen los parámetros del Aggregate, por lo que se elimina por completo antes de entregar la Release: el valor de un parámetro puede ser la propia credencial, ninguna regla lee el bloque, y así ningún valor de parámetro llega a un plugin linter a través de este campo. Presente solo en la entrada de una regla que lee una Release completa, donde proposed es el Aggregate que despliega esta Release, con sus valores de parámetros eliminados como describe proposed; se omite en cualquier otra entrada.
componentsmapa de objectnoEl Component del que cada instancia de componente del Aggregate es una instancia, indexado por el nombre de instancia que le da el Aggregate, que es la misma clave que usan los mapas components propios del Aggregate y de la Release. Cada valor es el Component al que se resuelve el tipo de la instancia, con cualquier cadena extends incorporada, convertido a JSON como lo es implemented_component. Una instancia cuyo Component no es accesible en los directorios de catálogo del espacio de trabajo está ausente, y una regla lee esa ausencia como no disponible en lugar de como un Component que no declara nada. Presente solo junto a release, en la entrada de una regla que lee una Release completa; se omite en cualquier otra entrada.
source_pathstringnoRuta del sistema de archivos desde la que se cargó la entidad. La rellenan los llamadores host que recorren el sistema de archivos del catálogo; la consumen las reglas que dependen de la ruta (p. ej., category-matches-directory). Se omite cuando el llamador no tiene contexto de ruta.
policiesPoliciesnoLa configuración de la disciplina de publicación por espacio de trabajo que consulta la regla, llevada como un objeto Policies que el host ensambla a partir de la configuración del espacio de trabajo y de las posibles sobrescrituras de la línea de comandos.

No se permiten propiedades adicionales.

LinterOutput

La forma de respuesta que emite el plugin de linter de publicación. findings lleva una entrada por cada invocación de regla que produjo un resultado. La regla de evolución del esquema emite exactamente un hallazgo (el veredicto de clasificación); las reglas estructurales pueden emitir cero (ninguna violación) o muchos (uno por infracción).

PropiedadTipoObligatoriaDescripción
findingsDiagnostic[]síHallazgos por regla producidos por la invocación del plugin, en el orden de emisión del plugin.
errorstringnoUn mensaje de error que se establece cuando el guest se ejecutó pero no pudo completar la operación; ausente en caso de éxito. Es distinto de cualquier diagnóstico que lleve la salida: los diagnósticos informan de problemas encontrados durante una ejecución que aun así produjo un resultado, mientras que error informa de que la propia operación no se completó. El host presenta un error presente como una invocación de plugin fallida.

No se permiten propiedades adicionales.

Policies

Configuración de la disciplina de publicación por espacio de trabajo que consulta el conjunto de reglas, ensamblada por el host a partir de los ajustes de disciplina de publicación de la configuración del espacio de trabajo y de las posibles sobrescrituras de la línea de comandos. Este esquema es el contrato de la forma. La omisión de un campo deja cada indicador en su valor predeterminado false, y el host escribe solo los campos cuyo valor no es el predeterminado.

PropiedadTipoObligatoriaDescripción
allow_dynamic_refsbooleanonoSi es true, se permite el uso de $dynamicAnchor / $dynamicRef en las entradas de SchemaLibrary (suprime la regla dynamic-refs). Valor predeterminado: false.
allow_id_overridesbooleanonoSi es true, se permiten las sobrescrituras de $id en las entradas de SchemaLibrary (suprime la regla id-overrides). Valor predeterminado: false.
allow_direct_x_aggrega_extensionsbooleanonoSi es true, se permite la autoría directa de x-aggrega-selector / x-aggrega-inject (suprime la regla x-aggrega-discouragement). Valor predeterminado: false.
allow_aggrega_ai_prefixbooleanonoSi es true, la regla annotation-prefix se suprime por completo (tanto la comprobación del aggrega.ai/ simple como la comprobación de feature.aggrega.ai/ condicionada al tipo). Valor predeterminado: false.
allow_nonstandard_namesbooleanonoSi es true, se permiten las violaciones de la forma del nombre (suprime la regla name-shape). Valor predeterminado: false.
allow_category_mismatchesbooleanonoSi es true, suprime los hallazgos de la regla category-matches-directory. La convención del catálogo estándar exige que los Components bajo core// declaren component.aggrega.ai/category={category} en correspondencia con el segmento del directorio, donde {category} es uno de los 15 valores del conjunto cerrado. Los espacios de trabajo con excepciones persistentes legítimas se excluyen aquí. Valor predeterminado: false.
allow_undeclared_recipe_providesbooleanonoSi es true, suprime los hallazgos de la regla provides-declared-by-component. Esa regla informa de cada clave que una Recipe publica en spec.provides y que el Component nombrado por su spec.implements no declara en el pilar provides de su spec.schema. Publicar más allá del contrato declarado se acepta en tiempo de build, por lo que el hallazgo es un aviso; un espacio de trabajo cuyas Recipes publican deliberadamente claves que su Component no declara se excluye aquí. Valor predeterminado: false.
allow_connection_credential_mismatchesbooleanonoSi es true, suprime los hallazgos de la regla connection-credential-matches-target-key. Esa regla lee una Release completa y compara, para cada conexión cuyo destino declara la clave que exige a sus llamadores, la credencial que presenta la conexión con la clave que tiene el destino: informa de dos extremos que nombran secretos distintos y de una clave declarada en un solo extremo. La concordancia entre los dos extremos es una convención del catálogo y no algo que compruebe un build, por lo que el hallazgo es un aviso; un espacio de trabajo cuyos dos extremos difieren deliberadamente se excluye aquí. Valor predeterminado: false.

No se permiten propiedades adicionales.