基盤・ツール

KatanA AST Lint

Rustの構文木とリポジトリ構造を検査するライブラリとkal CLIです。構造・禁止型・コード規約などの検査をプロジェクトやCIへ組み込めます。

KatanAシリーズのRustコード品質と構造規約を保つ開発者

01

実装済みの機能

ASTを使った規約検査

根拠

アーキテクチャや禁止型などのルール実装

根拠

検査結果をCIや開発時チェックへ組み込める構成

根拠

02

はじめ方

  1. CargoでCLIを導入し、検査するRustワークスペースへ移動します。
  2. kal checkを実行します。対象ルートやルールの重要度はkal.jsonで設定できます。

Rustと必要な開発ツールを準備し、導入前にリンク先のREADMEで環境要件を確認してください。実行例は機能の入口であり、すべての環境での動作を保証するものではありません。

根拠
sh
cargo install katana-ast-lint
kal check
kal check --json

01 / KAL

どんな場面で使うか

Rust repositoryのintegration gate

KatanaAstLint::from_workspace().assert_clean()をintegration testから呼び、共有されたRust AST rule setをrepositoryの品質gateに組み込みます。source rootsや例外は各repository側に残せます。

CIから標準AST ruleを実行

kal checkはworkspace rootを解決し、kal.jsonがあれば読み込んで標準ruleを実行します。--jsonまたは--textでreporter modeを選び、違反・設定エラー・system errorをexit statusで区別できます。

02 / KAL

入力から出力までの流れ

  1. workspaceと設定を解決

    try_from_workspaceはcurrent directoryからCargo workspace rootを探し、rootの設定を読み込みます。設定が不正または読めない場合はKalRunErrorとして返ります。

  2. source rootsへruleを適用

    lint_allがrule catalogを順に確認し、設定されたsource rootsまたはrule inputsへAST ruleを適用します。ruleごとのviolationsを収集し、rule ID順に安定化して返します。

  3. reportとexit statusを使う

    try_assert_cleanは違反をreporterへ渡し、CLIはviolationならexit 1、configurationまたはsystem errorならexit 2にします。integration testならassert_cleanで失敗をpanicとして受け取れます。

03 / KAL

主要API・CLIの使い分け

KatanaAstLint::try_from_workspace
current directoryからworkspace rootと設定を解決し、Result<KatanaAstLint, KalRunError>を返します。CLIやtest harnessが初期化失敗を分類して扱えます。
KatanaAstLint::from_workspace
workspace初期化を簡潔に書くpanic-on-error入口です。READMEのintegration test例のように、設定不能をtest failureとして扱いたい場合に使います。
violations
全ruleの結果を集め、rule ID順に並べたVec<Violation>を返します。reporterを介さず、テストや独自集計で違反データを直接検査できます。
kal check --json / --text
CLIのcheckは--jsonまたは--textを受け、標準rule setの結果を選択した形式で出力します。未知optionや設定失敗は違反とは別のexit 2になります。

04 / KAL

具体例で理解する

integration testでrepository全体を検査

READMEのintegration test例はKatanaAstLint::from_workspace()でworkspace設定を読み込み、assert_clean()で標準rule全体を実行します。共有runnerをrepository固有のtestへ組み込みたい場合の最小例です。

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

05 / KAL

組み込み条件と責務の境界

kal.jsonをrepository境界に置く

kal.jsonでsource roots、rule severity、rule enablement、repository-specific inputsを指定します。共有ruleの実装を変更せず、各repositoryの対象範囲と許容設定だけをローカルに保持できます。

既存Rust lintと併用する

KALは共有AST rule boundaryであり、Clippy、Dylint、ast-grep、Semgrepの代替ではありません。Rust compiler lintや検索系検査を置き換えず、KatanA共通の構造規約を追加する責務として導入します。

根拠

調査時点の公開リポジトリに基づく紹介です。リンク先の固定コミットで実装と手順を確認できます。

リポジトリREADMEf1d75d87d151
根拠 · KAL
すべての製品