Base e ferramentas

KatanA AST Lint

Biblioteca Rust e CLI kal para inspecionar a árvore sintática e a estrutura do repositório. Permite integrar regras de estrutura, tipos proibidos e estilo em projetos ou CI.

Desenvolvedores que mantêm a qualidade e as regras estruturais do código Rust do KatanA

01

Funções implementadas

Verificações baseadas em AST

Fontes

Regras de arquitetura e tipos proibidos

Fontes

Integração dos resultados em CI e verificações de desenvolvimento

Fontes

02

Primeiros passos

  1. Instale a CLI com Cargo e entre no workspace Rust a verificar.
  2. Execute kal check; configure raiz e severidade das regras em kal.json.

Prepare Rust e as ferramentas de desenvolvimento necessárias e consulte o README indicado para os requisitos antes da integração. Os exemplos são pontos de entrada e não garantem funcionamento em todos os ambientes.

Fontes
sh
cargo install katana-ast-lint
kal check
kal check --json

01 / KAL

Casos de uso

Gate de integração para um Rust repository

Chame KatanaAstLint::from_workspace().assert_clean() de um integration test e coloque o conjunto compartilhado de Rust AST rules no quality gate do repository. source roots e exceções continuam definidos em cada repository.

Executar regras AST padrão no CI

kal check resolve o workspace root, carrega kal.json quando existe e executa as rules padrão. Escolha o reporter mode com --json ou --text e diferencie violações, erro de configuração e system error pelo exit status.

02 / KAL

Fluxo da entrada à saída

  1. Resolver workspace e configuração

    try_from_workspace procura o Cargo workspace root a partir do diretório atual e lê a configuração na raiz. Configuração inválida ou ilegível retorna KalRunError.

  2. Aplicar rules aos source roots

    lint_all percorre o rule catalog e aplica cada AST rule aos source roots ou rule inputs configurados. Reúne violations por rule e retorna-as estabilizadas por rule ID.

  3. Usar report e exit status

    try_assert_clean entrega violations ao reporter; a CLI usa exit 1 para violation e exit 2 para configuration ou system error. Em integration test, assert_clean recebe a falha como panic.

03 / KAL

APIs e CLI principais

KatanaAstLint::try_from_workspace — Inicialização com erros
Resolve workspace root e configuração a partir do diretório atual e retorna Result<KatanaAstLint, KalRunError>. CLI e test harness podem classificar uma falha de inicialização.
KatanaAstLint::from_workspace — Inicialização do workspace
É a entrada panic-on-error para escrever a inicialização do workspace de forma curta. Use-a no exemplo de integration test quando uma configuração impossível deve virar falha de teste.
violations — Dados das violações
Reúne resultados de todas as rules e retorna Vec<Violation> ordenado por rule ID. Testes e agregadores próprios podem inspecionar diretamente os dados, sem reporter.
kal check --json / --text — Saída CLI
check aceita --json ou --text e imprime o resultado do standard rule set no formato escolhido. Unknown option ou falha de configuração não são violation: produzem exit 2.

04 / KAL

Entenda com um exemplo

Verificar todo o repository com um integration test

O exemplo chama KatanaAstLint::from_workspace() para carregar a configuração do workspace e assert_clean() para executar todas as rules padrão. É o menor exemplo de integração do runner compartilhado em um teste específico do repository.

rust
#[test]
fn repository_ast_lint() {
    katana_ast_lint::KatanaAstLint::from_workspace().assert_clean();
}

05 / KAL

Integração e limites

Colocar kal.json na fronteira do repository

Em kal.json, especifique source roots, rule severity, rule enablement e repository-specific inputs. O repository mantém localmente o escopo e as permissões sem alterar a implementação das rules compartilhadas.

Usar junto com outros linters Rust

KAL define uma shared AST rule boundary e não substitui Clippy, Dylint, ast-grep ou Semgrep. Não substitua compiler lint nem verificações de busca; adicione as regras estruturais comuns do KatanA.

Fontes

Apresentação baseada nos repositórios públicos disponíveis no momento da pesquisa. A implementação e os passos podem ser conferidos no commit fixado do link.

RepositórioLeia-mef1d75d87d151
Fontes · KAL
Todos os produtos