ベースライン

ベースラインは既存の指摘を記録する仕組みです。最初にすべてを修正しなくても、次回以降は記録されていない指摘だけを報告できます。

ベースラインを作る

未コミットの変更がない状態で、依存パッケージの取得とコード生成を行い、 kareki の指摘と解析警告を確認します。その後、指摘を保存します。

dart run kareki --baseline .kareki-baseline.json --write-baseline

.kareki-baseline.json をコミットします。次回以降は --baseline .kareki-baseline.json を指定するか、 kareki-config.yaml に次の設定を追加します。

baseline: .kareki-baseline.json

記録と一致する指摘は出力されず、終了コード 1 の原因にもなりません。新しい指摘があれば、従来どおり 1 になります。ベースラインの保存に成功すると 0 で終了しますが、標準エラー出力に解析警告が残る場合があります。CLI の終了コード を参照してください。

ベースラインを更新する

修正結果と新しい指摘を確認してから、同じ保存コマンドを再実行します。パスは、毎回 --baseline または設定ファイルで指定してください。不要な項目を削除する前に、doctor でも確認できます。

項目は差分を読みやすくするため、(ruleId, stableId) の順で並べます。 stableId に含まれるワークスペースの絶対パスは <root>/ に置き換えるため、マシンや CI の配置先が変わっても共有できます。