Base e strumenti
KatanA AST Lint
Libreria Rust e CLI kal per controllare albero sintattico e struttura del repository. Permette di integrare regole di struttura, tipi vietati e stile nei progetti o in CI.
Sviluppatori che mantengono qualità e regole strutturali del codice Rust di KatanA
01
Funzioni implementate
02
Per iniziare
- Installa la CLI con Cargo e spostati nel workspace Rust da controllare.
- Esegui kal check; configura radice e severità delle regole in kal.json.
Prepara Rust e gli strumenti di sviluppo necessari e consulta il README collegato per i requisiti prima dell'integrazione. Gli esempi sono punti di partenza e non garantiscono il funzionamento in ogni ambiente.
Fonticargo install katana-ast-lint
kal check
kal check --json01 / KAL
Casi d'uso
Quality gate per repository Rust
Chiama KatanaAstLint::from_workspace().assert_clean() da un integration test per integrare nel quality gate del repository il set condiviso di regole AST Rust. Source roots ed eccezioni restano nel repository che lo usa.
Eseguire le regole AST standard dalla CI
kal check risolve la workspace root, carica kal.json se esiste ed esegue le rule standard. Con --json o --text scegli la modalità reporter e distingui violazioni, errori di configurazione ed errori di sistema tramite exit status.
02 / KAL
Flusso da input a output
Risolvere workspace e configurazione
try_from_workspace cerca la root del Cargo workspace dal current directory e carica la configurazione della root. Se la configurazione è errata o illeggibile restituisce KalRunError.
Applicare le rule ai source roots
lint_all esamina in ordine il rule catalog e applica le regole AST ai source roots o agli input configurati. Raccoglie le violazioni di ogni regola e le restituisce stabilizzate per rule ID.
Usare report ed exit status
try_assert_clean passa le violazioni al reporter; la CLI usa exit 1 per violation e exit 2 per configuration o system error. In un integration test assert_clean riceve il fallimento come panic.
03 / KAL
API e CLI principali
KatanaAstLint::try_from_workspace — Inizializzazione fallibile- Risolve workspace root e configurazione dal current directory e restituisce Result<KatanaAstLint, KalRunError>. CLI e test harness possono classificare un errore d’inizializzazione.
KatanaAstLint::from_workspace — Inizializzazione del workspace- Entry point conciso panic-on-error per inizializzare il workspace. È utile nell’esempio di integration test del README quando una configurazione non valida deve diventare un test failure.
violations — Dati delle violazioni- Raccoglie i risultati di tutte le rule e restituisce Vec<Violation> ordinato per rule ID. Senza passare da reporter, test e aggregazioni personalizzate possono ispezionare direttamente i dati.
kal check --json / --text — Uscita CLI- check accetta --json o --text e stampa il risultato del set di rule standard nel formato scelto. Unknown option e configurazione fallita producono exit 2, distinto dalle violazioni.
04 / KAL
Capire con un esempio
Controllare l’intero repository in un integration test
L’esempio di integration test del README carica la configurazione workspace con KatanaAstLint::from_workspace() ed esegue tutte le rule standard con assert_clean(). È l’esempio minimo per integrare il runner condiviso in un test specifico del repository.
#[test]
fn repository_ast_lint() {
katana_ast_lint::KatanaAstLint::from_workspace().assert_clean();
}05 / KAL
Integrazione e limiti
Collocare kal.json al confine del repository
Con kal.json specifichi source roots, rule severity, rule enablement e repository-specific inputs. Senza modificare l’implementazione condivisa, ogni repository conserva localmente solo ambito e impostazioni consentite.
Usarlo insieme al lint Rust esistente
KAL è un confine per regole AST condivise e non sostituisce Clippy, Dylint, ast-grep o Semgrep. Non rimpiazza compiler lint o controlli di ricerca: aggiunge le regole strutturali comuni di KatanA.
Fonti
Presentazione basata sui repository pubblici disponibili al momento della ricerca. Implementazione e procedure sono verificabili nel commit fissato del link.