Base y herramientas

KatanA AST Lint

Biblioteca Rust y CLI kal para inspeccionar el árbol sintáctico y la estructura del repositorio. Permite integrar reglas de estructura, tipos prohibidos y estilo en proyectos o CI.

Desarrolladores que mantienen la calidad y las reglas estructurales del código Rust de KatanA

01

Funciones implementadas

Comprobaciones basadas en AST

Fuentes

Reglas de arquitectura y tipos prohibidos

Fuentes

Integración de resultados en CI y comprobaciones de desarrollo

Fuentes

02

Primeros pasos

  1. Instale la CLI con Cargo y vaya al workspace Rust que quiere comprobar.
  2. Ejecute kal check; configure la raíz y la severidad de las reglas en kal.json.

Prepare Rust y las herramientas de desarrollo necesarias y consulte el README enlazado para conocer los requisitos antes de integrar. Los ejemplos son puntos de entrada y no garantizan el funcionamiento en todos los entornos.

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

01 / KAL

Casos de uso

Usar un gate de integración para repositorios Rust

Llame a KatanaAstLint::from_workspace().assert_clean() desde un integration test e integre el conjunto compartido de reglas AST de Rust en el quality gate del repository. Cada repository conserva sus source roots y excepciones.

Ejecutar las reglas AST estándar desde CI

kal check resuelve el workspace root, carga kal.json si existe y ejecuta las reglas estándar. Elija reporter mode con --json o --text y distinga violation, configuration error y system error mediante exit status.

02 / KAL

Flujo de entrada a salida

  1. Resolver workspace y configuración

    try_from_workspace busca el Cargo workspace root desde current directory y lee la configuración de root. Si la configuración es inválida o no se puede leer, devuelve KalRunError.

  2. Aplicar rules a source roots

    lint_all recorre el rule catalog y aplica cada AST rule a los source roots configurados o a sus rule inputs. Recopila violations por rule y las devuelve estabilizadas por rule ID.

  3. Usar report y exit status

    try_assert_clean entrega las violations al reporter; la CLI devuelve exit 1 por violation y exit 2 por configuration o system error. En un integration test, assert_clean recibe el fallo como panic.

03 / KAL

APIs y CLI principales

KatanaAstLint::try_from_workspace — Inicialización con errores
Resuelve workspace root y configuración desde current directory y devuelve Result<KatanaAstLint, KalRunError>. CLI y test harness pueden clasificar el fallo de inicialización.
KatanaAstLint::from_workspace — Inicialización del workspace
Es la entrada panic-on-error para inicializar el workspace de forma concisa. Úsela como en el ejemplo de integration test del README cuando una configuración imposible debe ser test failure.
violations — Datos de infracciones
Recoge el resultado de todas las rules y devuelve un Vec<Violation> ordenado por rule ID. Permite inspeccionar directamente los datos de violation en tests o agregaciones propias, sin reporter.
kal check --json / --text — Salida CLI
check acepta --json o --text y emite el resultado del rule set estándar en el formato elegido. Un unknown option o un fallo de configuración produce exit 2, separado de una violation.

04 / KAL

Entender con un ejemplo

Proteger un repositorio desde un test de integración

El ejemplo del README llama a KatanaAstLint::from_workspace() en un test de integración, carga la configuración del workspace y ejecuta el conjunto estándar con assert_clean(). Es la forma mínima de integrar el runner compartido en un test específico del repositorio.

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

05 / KAL

Integración y límites

Colocar kal.json en el límite del repository

Defina en kal.json source roots, rule severity, rule enablement y repository-specific inputs. Así cada repository mantiene localmente su alcance y tolerancias sin cambiar la implementación de la rule compartida.

Combinarlo con el lint Rust existente

KAL es un shared AST rule boundary, no un sustituto de Clippy, Dylint, ast-grep o Semgrep. No reemplaza el Rust compiler lint ni las comprobaciones de búsqueda; añade las reglas estructurales comunes de KatanA.

Fuentes

Presentación basada en los repositorios públicos disponibles en el momento de la investigación. La implementación y los pasos se pueden comprobar en el commit fijado del enlace.

RepositorioLéamef1d75d87d151
Fuentes · KAL
Todos los productos