Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do socket Wasm de linter do Aggrega

Referência gerada. Não edite à mão — gere 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 hospeda muitas regras; o plugin seleciona qual regra executar por meio 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 compartilhado 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

  • LinterInput
  • LinterOutput

Definições

LinterInput

O payload que o host entrega ao plugin de linter de publicação a cada invocação. rule_id seleciona para qual regra o plugin despacha. entity_kind identifica o tipo de entidade submetida ao lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed carrega a estrutura analisada da entidade que está sendo classificada (o host analisa o YAML em JSON antes do envio; o plugin nunca vê bytes brutos). previous carrega a entidade analisada da versão anterior para a regra de evolução do esquema; omitido quando não se aplica. implemented_component carrega 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 carregam o restante 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 carrega a configuração da disciplina de publicação por espaço de trabalho que a regra consulta.

PropriedadeTipoObrigatóriaDescrição
rule_idstringsimA regra para a qual o plugin deve despachar, nomeada pelo seu id de regra — o mesmo identificador em kebab-case que o achado resultante carrega em rule_id, de modo que uma regra suprimida ou relatada é nomeada 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 um achado ‘unknown_rule’ em vez de uma aprovação silenciosa.
entity_kindstring (enum)simO tipo de entidade que os valores proposed/previous codificam. A classificação da regra de evolução do esquema varia conforme o tipo; as regras estruturais se limitam a tipos específicos. Valores permitidos: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectsimEstrutura analisada da entidade que está sendo classificada. O host converte o YAML em JSON antes do envio, de modo que o plugin recebe um valor já estruturado e nunca vê bytes brutos. Na entrada de uma regra que lê uma Release inteira, é o Aggregate que essa Release implanta. Em toda entrada, todo valor de parâmetro é removido antes de a entidade ser entregue, porque o valor de um parâmetro pode ser a própria credencial, de modo que nenhum valor de parâmetro chega a um plugin linter por este campo. Um Aggregate mantém as suas declarações spec.parameters, cada uma contendo apenas as chaves que o esquema do Aggregate admite em uma declaração de parâmetro, exceto default, e o mesmo vale para cada declaração aninhada sob properties, items e valuesType: um valor padrão é removido em vez de substituído, de modo que um plugin não consegue saber se uma declaração fornece um, e uma chave que o esquema não admite ali é removida com tudo o que contém. O bloco parameters de cada módulo sob spec.aggregates, que carrega os valores passados a esse módulo, é removido por inteiro, assim como spec.parameters em uma entidade de qualquer outro tipo. O texto de template que lê um parâmetro é mantido como está escrito.
previousobjectnãoEstrutura analisada da entidade da versão anterior, para regras que fazem 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_componentobjectnãoEstrutura analisada do Component que uma Recipe submetida ao lint nomeia em spec.implements, resolvido pelo host. É uma entidade relacionada de um tipo DIFERENTE daquela submetida ao lint, o que a distingue de previous: previous carrega outra versão da mesma entidade, enquanto este campo carrega o Component cujo contrato de saída declarado a Recipe realiza. O host o resolve pela mesma busca no catálogo que um build usa, com o nome do Component como chave, de modo 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 nomeia 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 nenhum achado quando ele está ausente.
releaseobjectnãoEstrutura analisada da Release que um lint com escopo de release nomeia, com a sua cadeia extends incorporada, de modo que uma Release filha carrega o que herda da sua base. O host a converte de YAML para JSON como faz com proposed. O seu bloco spec.parameters contém os valores que atendem aos parâmetros do Aggregate, por isso é 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 por este 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 como proposed descreve; omitido em qualquer outra entrada.
componentsmapa de objectnãoO Component do qual cada instância de componente do Aggregate é uma instância, indexado pelo nome de instância que o Aggregate lhe dá, que é a mesma chave usada 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 como implemented_component é. 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_pathstringnãoCaminho do sistema de arquivos do qual a entidade foi carregada. Preenchido por chamadores do host que percorrem o sistema de arquivos 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.
policiesPoliciesnãoA configuração da disciplina de publicação por espaço de trabalho que a regra consulta, carregada como um objeto Policies que o host monta a partir da configuração do espaço de trabalho e de eventuais substituições pela linha de comando.

Não são permitidas propriedades adicionais.

LinterOutput

A forma de resposta que o plugin de linter de publicação emite. findings carrega uma entrada por invocação de regra que produziu um resultado. A regra de evolução do esquema emite exatamente um achado (o veredito de classificação); as regras estruturais podem emitir zero (nenhuma violação) ou muitos (um por infração).

PropriedadeTipoObrigatóriaDescrição
findingsDiagnostic[]simAchados por regra produzidos pela invocação do plugin, na ordem de emissão do plugin.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. Ela é distinta de quaisquer diagnósticos que a saída carregue: os diagnósticos informam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error informa que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin com falha.

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 configurações de disciplina de publicação da configuração do espaço de trabalho e de eventuais substituições pela linha de comando. Este esquema é o contrato da forma. A omissão de um campo deixa cada flag no valor padrão false, e o host escreve apenas os campos cujo valor não é o padrão.

PropriedadeTipoObrigatóriaDescrição
allow_dynamic_refsbooleanonãoQuando true, o uso de $dynamicAnchor / $dynamicRef em entradas de SchemaLibrary é permitido (suprime a regra dynamic-refs). Padrão: false.
allow_id_overridesbooleanonãoQuando true, substituições de $id em entradas de SchemaLibrary são permitidas (suprime a regra id-overrides). Padrão: false.
allow_direct_x_aggrega_extensionsbooleanonãoQuando true, a autoria direta de x-aggrega-selector / x-aggrega-inject é permitida (suprime a regra x-aggrega-discouragement). Padrão: false.
allow_aggrega_ai_prefixbooleanonãoQuando true, a regra annotation-prefix é suprimida por completo (tanto a verificação do aggrega.ai/ simples quanto a verificação de feature.aggrega.ai/ condicionada ao tipo). Padrão: false.
allow_nonstandard_namesbooleanonãoQuando true, violações da forma do nome são permitidas (suprime a regra name-shape). Padrão: false.
allow_category_mismatchesbooleanonãoQuando true, suprime os achados da regra category-matches-directory. A convenção do catálogo padrão exige que os Components sob core// declarem component.aggrega.ai/category={category} correspondente ao segmento do diretório, em que {category} é um dos 15 valores do conjunto fechado. Espaços de trabalho com exceções persistentes legítimas se excluem aqui. Padrão: false.
allow_undeclared_recipe_providesbooleanonãoQuando true, suprime os achados da regra provides-declared-by-component. Essa regra relata cada chave que uma Recipe publica em spec.provides e que o Component nomeado pelo seu spec.implements não declara no pilar provides do seu spec.schema. Publicar além do contrato declarado é aceito em tempo de build, por isso o achado é um aviso; um espaço de trabalho cujas Recipes publicam deliberadamente chaves que o seu Component não declara se exclui aqui. Padrão: false.
allow_connection_credential_mismatchesbooleanonãoQuando true, suprime os achados da regra connection-credential-matches-target-key. Essa regra lê uma Release inteira e compara, para cada conexão cujo destino declara a chave que exige dos seus chamadores, a credencial que a conexão apresenta com a chave que o destino detém: relata duas pontas que nomeiam segredos diferentes e uma chave declarada em apenas uma ponta. A concordância entre as duas pontas é uma convenção do catálogo, e não algo que um build verifica, por isso o achado é um aviso; um espaço de trabalho cujas duas pontas diferem deliberadamente se exclui aqui. Padrão: false.

Não são permitidas propriedades adicionais.