Basis / Tool

KatanA AST Lint

Eine Rust-Bibliothek und kal-CLI zur Prüfung von Syntaxbäumen und Repository-Struktur, die Struktur-, verbotene-Typ- und Coding-Regeln in Projekte und CI integriert.

Entwickler, die Rust-Codequalität und Strukturkonventionen der KatanA-Serie pflegen

01

Implementierte Fähigkeiten

AST-basierte Regelprüfungen

Belege

Regeln für Architektur und verbotene Typen

Belege

Integration der Ergebnisse in CI und Entwicklungsprüfungen

Belege

02

Erste Schritte

  1. Installieren Sie die CLI mit Cargo und wechseln Sie in den zu prüfenden Rust-Workspace.
  2. Führen Sie kal check aus; konfigurieren Sie Quellwurzeln und Regel-Schweregrade in kal.json.

Bereiten Sie Rust und die erforderlichen Entwicklungstools vor und prüfen Sie vor der Installation die Umgebungsanforderungen im verknüpften README. Beispiele zeigen einen Einstieg und garantieren keinen Betrieb in jeder Umgebung.

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

01 / KAL

Anwendungsfälle

Rust-Repository-Integrationstor

Rufen Sie KatanaAstLint::from_workspace().assert_clean() aus dem Integrationstest auf, um den gemeinsam genutzten Rust-AST-Regelsatz in das Quality Gate des Repositorys zu integrieren. Quellwurzeln und Ausnahmen können in jedem Repository belassen werden.

Führen Sie Standard-AST-Regeln von CI aus

kal check löst das Arbeitsbereichsstammverzeichnis auf, liest kal.json, falls vorhanden, und führt die Standardregeln aus. Sie können den Reportermodus mit --json oder --text auswählen und Verstöße, Konfigurationsfehler und Systemfehler anhand des Exit-Status unterscheiden.

02 / KAL

Ablauf von Eingabe zu Ausgabe

  1. Arbeitsbereich und Einstellungen auflösen

    try_from_workspace sucht im aktuellen Verzeichnis nach dem Cargo-Workspace-Root und liest die Root-Konfiguration. Wenn die Einstellung ungültig oder nicht lesbar ist, wird ein KalRunError zurückgegeben.

  2. Regel auf Quellwurzeln anwenden

    lint_all durchläuft den Regelkatalog und wendet AST-Regeln auf die konfigurierten Quellstämme oder Regeleingaben an. Sammelt Verstöße für jede Regel, stabilisiert sie und gibt sie in der Reihenfolge ihrer Regel-ID zurück.

  3. Verwenden Sie den Berichts- und Exit-Status

    try_assert_clean übergibt den Verstoß an den Reporter, und die CLI erstellt Exit 1 für Verstöße und Exit 2 für Konfigurations- oder Systemfehler. Für Integrationstests können Sie „assert_clean“ verwenden, um Fehler als Panik zu akzeptieren.

03 / KAL

Wichtige APIs und CLI

KatanaAstLint::try_from_workspace — Fehlbare Workspace-Initialisierung
Löst den Arbeitsbereichsstamm und die Einstellungen aus dem aktuellen Verzeichnis auf und gibt Ergebnis<KatanaAstLint, KalRunError> zurück. CLI und Testumgebung können Initialisierungsfehler klassifizieren und behandeln.
KatanaAstLint::from_workspace — Workspace-Initialisierung
Dies ist ein Panic-on-Error-Einstiegspunkt, um die Arbeitsbereichsinitialisierung präzise zu schreiben. Verwenden Sie dies, wenn Sie Nichtkonfigurierbarkeit als Testfehler behandeln möchten, wie im Integrationstestbeispiel in der README-Datei.
violations — Verstoßdaten
Sammelt die Ergebnisse aller Regeln und gibt violations als Vec<Violation> nach rule ID geordnet zurück. Tests und eigene Aggregationen können diese Daten direkt prüfen, ohne einen Reporter zu verwenden.
kal check --json / --text — CLI-Ausgabe
Die CLI-Prüfung akzeptiert --json oder --text und gibt die Ergebnisse eines Standardregelsatzes im Format Ihrer Wahl aus. Unbekannte Optionen und Konfigurationsfehler führen zu Exit 2, was sich von Verstößen unterscheidet.

04 / KAL

An einem Beispiel verstehen

Untersuchen Sie das gesamte Repository mit einem Integrationstest

Das Integrationstestbeispiel in der README-Datei liest die Arbeitsbereichskonfiguration mit KatanaAstLint::from_workspace() und führt den gesamten Standardregelsatz mit assert_clean() aus. Dies ist ein Minimalbeispiel, wenn Sie einen gemeinsamen Runner in einen repository-spezifischen Test integrieren möchten.

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

05 / KAL

Integration und Grenzen

Fügen Sie kal.json in die Repository-Grenze ein

Geben Sie Quellwurzeln, Regelschweregrad, Regelaktivierung und Repository-spezifische Eingaben in kal.json an. Sie können nur die Umfangs- und Toleranzeinstellungen für jedes Repository lokal beibehalten, ohne die gemeinsame Regelimplementierung zu ändern.

Mit vorhandenen Rust-Linters zusammen verwenden

KAL ist eine gemeinsame AST-Regelgrenze und kein Ersatz für Clippy, Dylint, ast-grep oder Semgrep. Es ersetzt nicht den Rust-Compiler-Lint oder die suchbasierte Inspektion, sondern wird als Verantwortung für das Hinzufügen gemeinsamer Strukturregeln zu KatanA eingeführt.

Belege

Diese Übersicht basiert auf den öffentlichen Repositories zum Zeitpunkt der Prüfung. Implementierung und Nutzung können in den verknüpften fixierten Commits geprüft werden.

Code-RepositoryREADME-Dokumentf1d75d87d151
Belege · KAL
Alle Produkte