Esquema do socket Wasm de linter do Aggrega
Referência gerada. Não editar à mão — gerar novamente a partir do JSON Schema publicado.
ID do esquema: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json
As formas de transmissão que o socket de linter consome (LinterInput) e emite (LinterOutput). O linter é executado no momento da publicação sobre um par de entidades versão anterior + versão proposta (a regra de evolução do esquema) e no momento da verificação de convenções do espaço de trabalho sobre entidades individuais (regras estruturais por regra). Um único plugin Wasm distribuído aloja muitas regras; o plugin seleciona qual regra executar através de LinterInput.rule_id. Este esquema é a fonte única de ambas as formas de transmissão: os tipos de payload de Go, Rust e TypeScript são gerados a partir dele no pacote partilhado da ABI de plugins, e cada kit de plugins reexporta esses tipos gerados em vez de declarar a sua própria cópia.
Uma das seguintes formas
LinterInputLinterOutput
Definições
LinterInput
O payload que o host entrega ao plugin de linter de publicação em cada invocação. rule_id seleciona a regra para a qual o plugin despacha. entity_kind identifica o tipo de entidade submetida ao lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed transporta a estrutura analisada da entidade a classificar (o host analisa o YAML para JSON antes do envio; o plugin nunca vê bytes em bruto). previous transporta a entidade analisada da versão anterior para a regra de evolução do esquema; omitido quando não se aplica. implemented_component transporta uma entidade relacionada de um tipo diferente — o Component que uma Recipe submetida ao lint realiza — para regras que comparam uma entidade com um contrato que outra entidade declara; omitido quando não se aplica. release e components transportam o resto de uma Release para uma regra que lê uma inteira — proposed é então o Aggregate que a Release implanta, release essa Release, e components o Component do qual cada uma das instâncias de componente do Aggregate é uma instância; ambos são omitidos em qualquer outra entrada. policies transporta a configuração da disciplina de publicação por espaço de trabalho que a regra consulta.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
rule_id | string | sim | A regra para a qual o plugin deve despachar, identificada pelo seu id de regra — o mesmo identificador em kebab-case que a constatação resultante transporta em rule_id, pelo que uma regra suprimida ou reportada é identificada da mesma forma em todas as superfícies. O conjunto reconhecido é aquele para o qual o plugin distribuído despacha; um id de regra que o plugin não reconhece produz uma constatação ‘unknown_rule’ em vez de uma aprovação silenciosa. |
entity_kind | string (enum) | sim | O tipo de entidade que os valores proposed/previous codificam. A classificação da regra de evolução do esquema varia consoante o tipo; as regras estruturais limitam-se a tipos específicos. Valores permitidos: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate" |
proposed | objeto | sim | Estrutura analisada da entidade a classificar. O host converte o YAML em JSON antes do envio, pelo que o plugin recebe um valor já estruturado e nunca vê bytes em bruto. Na entrada de uma regra que lê uma Release inteira, é o Aggregate que essa Release implanta. Em todas as entradas, todos os valores de parâmetros são removidos antes de a entidade ser entregue, porque o valor de um parâmetro pode ser a própria credencial, pelo que nenhum valor de parâmetro chega a um plugin linter através deste campo. Um Aggregate mantém as suas declarações spec.parameters, cada uma contendo apenas as chaves que o esquema do Aggregate admite numa declaração de parâmetro, exceto default, e o mesmo se aplica a cada declaração aninhada sob properties, items e valuesType: um valor predefinido é removido em vez de substituído, pelo que um plugin não consegue saber se uma declaração fornece um, e uma chave que o esquema não admite nesse ponto é removida com tudo o que contém. O bloco parameters de cada módulo sob spec.aggregates, que transporta os valores passados a esse módulo, é removido por inteiro, tal como spec.parameters numa entidade de qualquer outro tipo. O texto de template que lê um parâmetro é mantido tal como está escrito. |
previous | objeto | não | Estrutura analisada da entidade da versão anterior, para regras que efetuam uma comparação aos pares (evolução do esquema), com os seus valores de parâmetros removidos exatamente como são removidos de proposed. Omitido quando a regra não precisa de uma referência à versão anterior (por exemplo, primeira publicação, regras apenas estruturais). |
implemented_component | objeto | não | Estrutura analisada do Component que uma Recipe submetida ao lint indica em spec.implements, resolvido pelo host. É uma entidade relacionada de um tipo DIFERENTE daquela submetida ao lint, o que a distingue de previous: previous transporta outra versão da mesma entidade, enquanto este campo transporta o Component cujo contrato de saída declarado a Recipe realiza. O host resolve-o através da mesma pesquisa no catálogo que um build utiliza, com o nome do Component como chave, pelo que as três formas de fixação que spec.implements aceita (sem versão, exata, intervalo compatível com a versão principal) chegam à mesma entrada. Omitido quando a entidade submetida ao lint não é uma Recipe, quando não indica nenhum Component ou quando nenhum Component com esse nome está acessível nos diretórios de catálogo do espaço de trabalho. Um valor ausente significa que a comparação não está disponível, não que o contrato está vazio: uma regra que lê este campo não emite nenhuma constatação quando está ausente. |
release | objeto | não | Estrutura analisada da Release que um lint com âmbito de release indica, com a sua cadeia extends incorporada, pelo que uma Release filha transporta o que herda da sua base. O host converte-a de YAML para JSON tal como faz com proposed. O seu bloco spec.parameters contém os valores que cumprem os parâmetros do Aggregate, pelo que é removido por inteiro antes de a Release ser entregue: o valor de um parâmetro pode ser a própria credencial, nenhuma regra lê o bloco e, assim, nenhum valor de parâmetro chega a um plugin linter através deste campo. Presente apenas na entrada de uma regra que lê uma Release inteira, em que proposed é o Aggregate que esta Release implanta, com os seus valores de parâmetros removidos tal como proposed descreve; omitido em qualquer outra entrada. |
components | mapa de object | não | O Component do qual cada instância de componente do Aggregate é uma instância, indexado pelo nome de instância que o Aggregate lhe atribui, que é a mesma chave utilizada pelos mapas components próprios do Aggregate e da Release. Cada valor é o Component para o qual o tipo da instância se resolve, com qualquer cadeia extends incorporada, convertido em JSON tal como implemented_component o é. Uma instância cujo Component não está acessível nos diretórios de catálogo do espaço de trabalho fica ausente, e uma regra lê essa ausência como indisponível em vez de como um Component que não declara nada. Presente apenas ao lado de release, na entrada de uma regra que lê uma Release inteira; omitido em qualquer outra entrada. |
source_path | string | não | Caminho do sistema de ficheiros a partir do qual a entidade foi carregada. Preenchido pelos chamadores do host que percorrem o sistema de ficheiros do catálogo; consumido por regras sensíveis ao caminho (por exemplo, category-matches-directory). Omitido quando o chamador não tem contexto de caminho. |
policies | Policies | não | A configuração da disciplina de publicação por espaço de trabalho que a regra consulta, transportada como um objeto Policies que o host monta a partir da configuração do espaço de trabalho e de eventuais substituições na linha de comandos. |
Não são permitidas propriedades adicionais.
LinterOutput
A forma de resposta que o plugin de linter de publicação emite. findings transporta uma entrada por cada invocação de regra que produziu um resultado. A regra de evolução do esquema emite exatamente uma constatação (o veredicto de classificação); as regras estruturais podem emitir zero (nenhuma violação) ou muitas (uma por infração).
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
findings | Diagnostic[] | sim | Constatações por regra produzidas pela invocação do plugin, pela ordem de emissão do plugin. |
error | string | não | Uma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. É distinta de quaisquer diagnósticos que a saída transporte: os diagnósticos reportam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error reporta que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin falhada. |
Não são permitidas propriedades adicionais.
Policies
Configuração da disciplina de publicação por espaço de trabalho que o conjunto de regras consulta, montada pelo host a partir das definições de disciplina de publicação da configuração do espaço de trabalho e de eventuais substituições na linha de comandos. Este esquema é o contrato da forma. A omissão de um campo deixa cada flag no valor predefinido false, e o host escreve apenas os campos cujo valor não é o predefinido.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
allow_dynamic_refs | booleana | não | Quando true, a utilização de $dynamicAnchor / $dynamicRef em entradas de SchemaLibrary é permitida (suprime a regra dynamic-refs). Valor predefinido: false. |
allow_id_overrides | booleana | não | Quando true, as substituições de $id em entradas de SchemaLibrary são permitidas (suprime a regra id-overrides). Valor predefinido: false. |
allow_direct_x_aggrega_extensions | booleana | não | Quando true, a autoria direta de x-aggrega-selector / x-aggrega-inject é permitida (suprime a regra x-aggrega-discouragement). Valor predefinido: false. |
allow_aggrega_ai_prefix | booleana | não | Quando true, a regra annotation-prefix é totalmente suprimida (tanto a verificação do aggrega.ai/ simples como a verificação de feature.aggrega.ai/ condicionada ao tipo). Valor predefinido: false. |
allow_nonstandard_names | booleana | não | Quando true, as violações da forma do nome são permitidas (suprime a regra name-shape). Valor predefinido: false. |
allow_category_mismatches | booleana | não | Quando true, suprime as constatações da regra category-matches-directory. A convenção do catálogo padrão exige que os Components sob core/ |
allow_undeclared_recipe_provides | booleana | não | Quando true, suprime as constatações da regra provides-declared-by-component. Essa regra reporta cada chave que uma Recipe publica em spec.provides e que o Component indicado pelo seu spec.implements não declara no pilar provides do seu spec.schema. Publicar para além do contrato declarado é aceite no momento do build, pelo que a constatação é um aviso; um espaço de trabalho cujas Recipes publicam deliberadamente chaves que o seu Component não declara exclui-se aqui. Valor predefinido: false. |
allow_connection_credential_mismatches | booleana | não | Quando true, suprime as constatações da regra connection-credential-matches-target-key. Essa regra lê uma Release inteira e compara, para cada ligação cujo destino declara a chave que exige aos seus chamadores, a credencial que a ligação apresenta com a chave que o destino detém: reporta duas extremidades que indicam segredos diferentes e uma chave declarada apenas numa extremidade. A concordância entre as duas extremidades é uma convenção do catálogo, e não algo que um build verifica, pelo que a constatação é um aviso; um espaço de trabalho cujas duas extremidades diferem deliberadamente exclui-se aqui. Valor predefinido: false. |
Não são permitidas propriedades adicionais.