kareki ドキュメント
kareki ドキュメント
kareki は、Dart / Flutter のワークスペース全体からデッドコードを見つけるツールです。Melos / pub workspace 内の参照をパッケージ横断で解析し、パッケージ単位の解析では見つけられない未使用の public API、ファイル、依存パッケージ、引数を検出します。
段階的に導入できるよう、生成コード向けのプリセット、既存の指摘を保存するベースライン、不要になった設定を確認する kareki doctor を備えています。
クイックスタート
開発用依存に kareki を追加します。
pubspec.yaml
dev_dependencies:
kareki: ^0.7.0プロジェクトの依存パッケージを取得し、コード生成を実行してから、 ワークスペースのルートで実行します。
dart run kareki検出できるもの
| ルール | 検出対象 |
|---|---|
unused_element | ワークスペースのどこからも呼ばれていない public 宣言 |
unused_file | import、export、part の対象になっていない Dart ファイル |
unused_pub_dependency | 宣言されているものの、ソース、解析設定、ネイティブプラグイン、フォントアセットのいずれでも使用が確認できないパッケージ |
test_only_used | テストからしか参照されていないライブラリ宣言 |
unused_parameter | 宣言内で一度も読まれない引数 |
unused_parameter_optional | どの呼び出し元からも渡されない省略可能な引数 |
類似ツールとの比較
主な6項目の比較です。✅ 対応（オプションでの有効化を含む）、— 該当機能なし。
| 機能 | kareki | ciach | Dart Code Linter | dependency_validator | Dart 標準解析 |
|---|---|---|---|---|---|
| 未使用 public 宣言・メンバー | ✅ | ✅ | ✅ | — | — |
| 未使用 private 宣言・メンバー | — | ✅ | ✅ | — | ✅ |
| 起点から到達できない public 宣言の循環参照 | ✅ | — | — | — | — |
| 未使用 Dart ファイル | ✅ | — | ✅ | — | — |
| 未使用の pub 依存パッケージ | ✅ | — | — | ✅ | — |
| ベースラインで新規指摘だけを報告 | ✅ | — | — | — | — |
ほかの機能、各ツールの設定条件・制限、比較した版は詳しい比較 を参照してください。
ドキュメント
- CLI リファレンス — コマンド、オプション、出力形式、終了コード
- 設定 — ワークスペース設定、プリセット、除外、抑制
- ベースライン — 既存コードベースへ段階的に導入する方法
- Doctor — 不要になった除外設定や抑制を検出する方法
- 解析の仕組み — 解析の流れと制約
- 類似ツールとの比較 — ciach、Dart Code Linter などの Dart 向けツールとの違い
- 運用のベストプラクティス — cron と AI エージェントによる定期的なクリーンアップ
リンク
最終更新日