レッスン 2
サイドバイサイドと unified diff
変更をレビューするときに適切なビューを選ぶ：整列列 vs パッチ形式出力。
ほとんどの diff ツールは 2 つの表示スタイルを提供します。
サイドバイサイドビュー
元のテキストが左、変更後が右に表示されます。一致する行は整列し、追加・削除・変更行は各列でハイライトされます。
サイドバイサイドを使うとき：
- 両方のバージョンを同時に読みたい
- 設定や env ファイルを行ごとに比較している
- 行が移動、変更、置換されたかを確認する必要がある
unified diff ビュー
unified diff は接頭辞付きの 1 つの出力ストリームを示します。
--- original
+++ modified
DEBUG=false
-DEBUG=false
+DEBUG=true
DB_HOST=db.internal
-DB_HOST=db.internal
+DB_HOST=db.prod.internal
+CACHE_TTL=3600
- で始まる行は削除、 + で始まる行は追加、コンテキスト行には接頭辞がありません。
unified diff を使うとき：
- ノートやチケット向けのパッチ形式出力が欲しい
- チャットやメールに貼り付けるコンパクトな要約が必要
- Git やコードレビューの diff 形式に慣れている
どちらのビューを選ぶか
| シナリオ | より良いビュー |
|---|---|
| env/設定ファイルのレビュー | サイドバイサイド |
| チームメイトに変更を説明 | unified |
| 少数の値の編集確認 | サイドバイサイド |
| Issue コメントに diff を貼り付け | unified |
要点
サイドバイサイドは読むため、unified は共有のためです。どちらも同じ変更を記述します。異なるレビュータスク向けに最適化されているだけです。
同じサンプルを比較しながら Text Diff Checker でビューを切り替え、ワークフローに合う方を確認してください。