Git add -p を使ったパッチのステージング
Staging patches with Git add -p (simonholywell.com)
要約
Git add -p コマンドは、ファイル全体ではなく、変更された部分(hunk)ごとにインタラクティブにステージングできる強力な機能です。これにより、コミット内容を細かくレビューし、誤りを早期に発見したり、関連する変更を別々のコミットにまとめたりすることが可能になります。この機能は、日常的なGitワークフローにおいて、よりクリーンで整理されたコミット履歴を作成するために非常に役立ちます。
全文翻訳
Staging patches with git add
Introduction
git add -p をまだ使っていないなら、損をしています。このコマンドを使うと、ファイル全体だけでなく、その一部をインタラクティブにステージングでき、Gitのコミットプロセスをより細かく制御できるようになります。
なぜこれを使うべきなのか?
私がワークフローで git add -p を好む理由はいくつかあります。主な理由は、ステージングしながら変更を確認できるため、しばしば間違いを発見できるからです。ステージング中に変更を確認することで、初期のコーディングやコンテンツ作成中に見落とされた可能性のあるバグ、タイポ、その他の問題を検出できます。
さらに別の利点もあります。それは、ファイルの一部だけをステージングできることです。Gitは奇妙なことに、これらの部分を「ハング (hunks)」と呼びますので、以降はこの用語を使用します。
この機能は、多くの変更を行ったものの、それらを異なるコミットにグループ化したい場合に非常に役立ちます。例えば、1つのファイルの異なる部分で複数の関連する変更を行ったと想像してください。git add -p を使えば、これらの変更を選択的にステージングし、よりクリーンで整理されたコミットを保証できます。
ファイルの一部をステージングする
以下は、差分が表示され、「Stage this hunk?」とプロンプトされるインターフェースの例です。
diff --git a/main.mts b/main.mts
index e1132f2..8f7c279 100644
--- a/main.mts
+++ b/main.mts
@@ -1,2 +1,4 @@
export const add = (a, b) => a + b
+export const div = (a, b) => a / b
export const sum = (xs) => xs.reduce((acc, x) => sum(acc, x))
+export const avg = (xs) => div(sum(xs), xs.length)
(1/1) Stage this hunk [y,n,q,a,d,s,e,?]?
最も簡単な形式では、y を入力してその差分をコミット用にステージングするか、n を入力してステージングしないことができます。この例では、avg 関数をコミットする準備はできていませんが、div をプッシュアップしたいので、ハングをより小さなハングに分割するために s を入力することを選択します。すると、Gitは次のように尋ねます。
Split into 2 hunks.
@@ -1,2 +1,3 @@
export const add = (a, b) => a + b
+export const div = (a, b) => a / b
export const sum = (xs) => xs.reduce((acc, x) => sum(acc, x))
(1/2) Stage this hunk [y,n,q,a,d,j,J,g,/,e,?]?
コミット用にそのハングをステージングするために y を入力すると、Gitは次のハングで応答します。
@@ -2 +3,2 @@
export const sum = (xs) => xs.reduce((acc, x) => sum(acc, x))
+export const avg = (xs) => div(sum(xs), xs.length)
(2/2) Stage this hunk [y,n,q,a,d,K,g,/,e,?]?
div 関数のみをコミットしたいことを覚えておいて、インタラクティブなハングステージングを終了するために q を入力します。
ハングステージングと対話した後、コマンドプロンプトに戻ります。そこから、git commit やその他の必要なコマンドに進むことができます。
動作確認
ステージングされたファイルを確認するために git status を実行した場合、ファイル (main.mts) が「コミット対象」と「ステージングされていない変更」の両方のセクションに表示されるはずです。これは、ファイルの一部のみをステージングし、それが意図したものであったためです!
On branch main
Your branch is ahead of 'origin/main' by 1 commit.
(use "git push" to publish your local commits)
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: main.mts
Changes not staged for commit:
(use "git add/rm <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: main.mts
ファイルの一部のみを選択的にステージングすることで、次のコミットのために1つのハング(パッチ)を正常に準備できました。
その他のオプション
応答のリスト ([y,n,q,a,d,s,e,?]) は短縮されていますが、? を入力してヘルプドキュメントを取得することで、拡張情報を得ることができます。
インタラクティブなハングステージング中に使用できる応答オプションをいくつか示します。これらは Gitドキュメント から抜粋したものです。先ほど見たリストよりも多くのオプションがあることに気づくでしょう。
y: このハングをステージングするn: このハングをステージングしないa: このハングと、ファイル内の残りのすべてのハングをステージングするd: このハングも、残りのハングもステージングしないg: 移動先のハングを選択する/: 指定した正規表現に一致するハングを検索するj: このハングは未決定のままにし、次に未決定のハングを表示するJ: このハングは未決定のままにし、次のハングを表示するk: このハングは未決定のままにし、前の未決定のハングを表示するK: このハングは未決定のままにし、前のハングを表示するs: 現在のハングをより小さなハングに分割するe: 現在のハングを手動で編集する?: ヘルプを表示する
使用しない場合
私はほぼ毎日、コミットするたびに git add -p を使用しています。使用しないのは2つの場合です。
- 初めてコミットする新規作成ファイルがある場合 - ファイルが新しく作成された場合、比較対象となる以前のバージョンがないため、
git add -pはステージングを承認するための差分を提示できません。 - まれに、ディレクトリ全体をコミットしたい場合で、その内容に自信がある場合は、標準的なアプローチを選択することがよくあります。しかし、そのようなエッジケースでも、より細かい制御のために
git add -pを使用することがよくあります。
Conclusion
git add -p をワークフローに組み込むことで、Gitおよびコミットプロセスを効率化できます。このテクニックは、誇張なしに、変更セットをGitにコミットする必要があるほぼすべての回で使用しています。これにより、ステージングしながらコードを簡単にレビューでき、各コミットに何が含まれるかを正確に制御できます。