Base / outil

KatanA AST Lint

Une bibliothèque Rust et une CLI kal pour vérifier les arbres syntaxiques et la structure d'un dépôt, en intégrant des règles de structure, de types interdits et de code dans les projets et la CI.

Développeurs qui maintiennent la qualité et les conventions structurelles du code Rust de la série KatanA

01

Capacités implémentées

Intégration des résultats dans la CI et les vérifications de développement

Références

02

Premiers pas

  1. Installez la CLI avec Cargo et placez-vous dans le workspace Rust à vérifier.
  2. Lancez kal check ; configurez les racines source et la sévérité dans kal.json.

Préparez Rust et les outils de développement nécessaires, puis consultez le README lié pour les prérequis avant l'installation. Les exemples indiquent un point de départ et ne garantissent pas le fonctionnement dans tous les environnements.

Références
sh
cargo install katana-ast-lint
kal check
kal check --json

01 / KAL

Cas d'utilisation

Un gate d'intégration du dépôt

Appelez KatanaAstLint::from_workspace().assert_clean() depuis un integration test pour charger le workspace et appliquer le rule set AST Rust partagé. Les source roots et exceptions restent dans la configuration de chaque dépôt.

Exécuter les rules AST en CI

kal check résout le workspace root, charge kal.json s'il existe et exécute les rules standard. Choisissez --json ou --text et distinguez violations, erreurs de configuration et erreurs système par exit status.

02 / KAL

Flux entrée-sortie

  1. Résoudre workspace et configuration

    try_from_workspace remonte depuis le répertoire courant jusqu'au Cargo workspace root et charge sa configuration. Une configuration absente, invalide ou illisible devient KalRunError.

  2. Appliquer les rules aux source roots

    lint_all parcourt le rule catalog et applique chaque AST rule aux source roots ou rule inputs configurés. Il collecte les violations par rule et les renvoie dans l'ordre stable des rule ID.

  3. Produire le report et le status

    try_assert_clean transmet les violations au reporter. La CLI renvoie 1 pour une violation et 2 pour une erreur de configuration ou système ; assert_clean transforme l'échec en panic dans un integration test.

03 / KAL

API et CLI principales

KatanaAstLint::try_from_workspace — Initialisation avec erreurs
Résout workspace root et configuration depuis le répertoire courant et renvoie Result<KatanaAstLint, KalRunError>, afin que CLI et test harness distinguent l'initialisation des violations.
KatanaAstLint::from_workspace — Initialisation du workspace
Entrée concise panic-on-error utilisée par l'exemple d'intégration : elle renvoie le linter configuré ou panique si le workspace ne peut être initialisé.
violations — Données des violations
Exécute toutes les rules, collecte les résultats, les trie par rule ID et renvoie Vec<Violation>. Les tests et reporters peuvent inspecter les données sans passer par le reporter CLI.
kal check --json / --text — Sortie CLI
Exécute les rules standard avec le format JSON ou texte choisi. Option inconnue ou échec workspace/configuration = exit 2, distinct de l'exit 1 des violations.

04 / KAL

Comprendre par un exemple

Contrôler tout le dépôt avec un test d'intégration

L'exemple de test d'intégration appelle KatanaAstLint::from_workspace() pour charger la configuration du workspace, puis assert_clean() pour appliquer l'ensemble des règles standard. Il montre comment intégrer le runner partagé à un test propre au dépôt, pas comment compiler ou typer le code Rust.

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

05 / KAL

Intégration et limites

Garder kal.json à la frontière du dépôt

Utilisez kal.json pour source roots, rule severity, rule enablement et repository-specific inputs. La portée et les exceptions restent locales sans changer l'implémentation partagée.

L'exécuter avec les lints Rust

KAL est une frontière de rules AST partagées, pas un remplacement de rustc, Clippy, Dylint, ast-grep ou Semgrep. Conservez lints du compilateur et recherches, puis ajoutez KAL pour les conventions structurelles communes à KatanA.

Références

Cette présentation repose sur les dépôts publics au moment de l'examen. Vérifiez l'implémentation et l'utilisation dans les commits figés liés.

DépôtFichier READMEf1d75d87d151
Références · KAL
Tous les produits