CLI リファレンス
ワークスペースのルートで実行します。
dart run kareki事前準備
プロジェクトの SDK で依存パッケージを取得し（dart pub get、flutter pub get、またはワークスペースの初期化コマンド）、コード生成を実行してください。生成ファイルや除外ファイルも参照の解析に使うため、正常に解決できる必要があります。
SDK と analyzer は、プロジェクトで使う言語機能に対応している必要があります。実験的な構文をパースできるだけでは不十分です。参照の解決が不要なルールは、依存パッケージの準備なしでも実行できます。
オプション
| オプション | 説明 |
|---|---|
--root <path> | ワークスペースのルート。デフォルトは現在のディレクトリ。 |
-f, --format <name> | 出力形式。text または json。設定ファイルより優先。 |
--packages <name> | 指定したパッケージの指摘だけを報告。参照は探索したワークスペース全体から収集。複数回指定可能。 |
--rule <id> | 指定したルールだけを有効化。複数回指定可能。 |
--strict | unused_pub_dependency で dev_dependencies も検査。 |
--baseline <path> | このベースラインに記録された指摘を出力から除外。設定ファイルの baseline より優先。 |
--write-baseline | 現在の指摘を保存して終了。オプションまたは設定ファイルでベースラインのパス指定が必要。 |
-h, --help | 使い方を表示。 |
たとえば、宣言単位で解析するルールだけを実行する場合は次のように指定します。
dart run kareki --rule unused_element,test_only_used,unused_parameter_optionalignore.packages も --packages と同じく報告だけを抑制し、利用側のコードは解析に残します。一方、packages.exclude はパッケージの探索対象から除外します。詳しくは設定
を参照してください。
結果と終了コード
| コード | 意味 |
|---|---|
0 | 抑制後の指摘がない、またはベースラインの保存に成功した。 |
1 | 抑制後に 1 件以上の指摘が残っている。 |
2 | 参照の解決や gen-l10n 入力の読み込みに失敗した。指摘の出力もベースラインの保存も行わない。 |
64 | CLI オプションまたは kareki の設定が不正。 |
解析警告は、未使用の確定ではなく、使用状況を判断しきれないことを示します。テキスト・JSON の指摘とは別に**標準エラー出力（stderr）**へ出力され、ルール ID や専用の終了コードはありません。警告だけで終了コードが変わることはなく、通常の実行では警告があっても 0 になり得ます。--write-baseline の保存も妨げないため、ベースラインを採用する前に標準エラー出力を確認してください。
kareki doctor は扱いが異なります。警告があると抑制設定やベースラインの整理可否を安全に判断できないため、2 で終了します。doctor
を参照してください。
更新後もコマンドは dart run kareki のままです。専用の移行コマンドやベースラインの形式変換は不要ですが、ベースラインを書き換える前に新しい指摘を確認してください。analysis_mode / --analysis-mode を指定していた場合は削除します。これらの廃止されたオプションを指定すると終了コード 64 になります。