こんにちは、さるまりんです。
Gitを使って作業していると、
「この変更、まだcommitできないな」
ということがあります。
そんなときに使えるのが、
git stashです。
変更した内容を一旦よけておいて、あとから戻すことができます。
でも、
git stashをそのまま使うと、変更しているものをまとめて退避することになります。
そうではなく、
このファイルだけ一旦よけたい。
ということもあります。
今回は、git stash で特定のファイルだけを退避する方法を見ていきます。
まずは普通のgit stash
例えば、いくつかのファイルを変更しているとします。
src/User.php
src/Order.php
README.mdここで、
git statusを見ると、
modified: src/User.php
modified: src/Order.php
modified: README.mdのようになっているとします。
この状態で、
git stashを実行すると、変更している内容を一旦stashに退避できます。
便利ですね。
ただ今回は、
src/User.phpだけを一旦よけたいとします。
Order.php と README.md の変更は、そのまま残しておきたい。
そんなときには、ファイルを指定してstashします。
特定のファイルだけstashします
こんなふうに書けます。
git stash push -- src/User.phpこれで、
src/User.phpの変更だけがstashされます。
もう一度、
git statusを確認すると、
src/Order.php
README.mdの変更は残っています。
つまり、
指定したファイルだけ一旦よける
ことができます。
-- の後ろに、stashしたいファイルを書くんですね。
複数のファイルも指定できます
一つだけではなく、複数のファイルを指定することもできます。
例えば、
git stash push -- src/User.php src/Order.phpとすれば、
src/User.php
src/Order.phpの変更をstashして、
README.mdの変更はそのまま残せます。
全部を一度によける必要はありません。
必要なものだけを選べます。
ワイルドカードを使ってまとめて指定することもできます
ファイルを一つずつ書く以外に、* を使ってまとめて指定することもできます。
例えば、
git stash push -- 'src/*.php'とすると、src 以下でパターンに一致するPHPファイルをまとめてstashできます。
「このあたりのPHPファイルだけ一旦よけたい」
というときには便利そうですね。
ここでは、
*.phpの部分が、PHPファイルに一致するパターンになっています。
なお、
git stash push -- 'src/*.php'のようにパターン全体をクォートしておくと、* をシェル側で先に展開させず、Gitのpathspecとして扱わせることができます。
Gitの通常のpathspecでは、* がディレクトリの区切りにも一致することがあります。そのため、'src/*.php' は src 直下だけではなく、その下のディレクトリにあるPHPファイルにも一致することがあります。
「このディレクトリ直下だけ」と思って使うと少し動きが違うことがあるので、そこだけ覚えておくと安心です。
stashしたものを確認します
stashした内容は、
git stash listで確認できます。
例えば、
stash@{0}: WIP on main: ...のように表示されます。
stashを何回か使っていると、
stash@{0}
stash@{1}
stash@{2}のように増えていきます。
一番新しいものが、
stash@{0}です。
どれだったかな？名前をつけておくとわかりやすい
stashが増えてくると、
「これ、何をよけたやつだっけ？」
となることがあります。
そんなときは、メッセージをつけておくとわかりやすいです。
git stash push -m "User.phpの変更" -- src/User.phpそして、
git stash listを見ると、何のためにstashしたのかがわかりやすくなります。
少し長く置いておく可能性があるなら、名前をつけておくと安心です。
stashした変更を戻します
一番新しいstashを戻すなら、
git stash popです。
stashした変更がワークツリーに戻ってきます。
pop は、変更を戻したあと、そのstashを一覧から取り除きます。
一方、
git stash applyというものもあります。
こちらも変更を戻しますが、stash自体は残ります。
つまり、
pop
→ 戻して、stashからも取り除く
apply
→ 戻すけれど、stashは残しておくという違いがあります。
普段は pop で十分なことも多いですが、
「念のためstashを残しておきたい」
というときには、apply を使う方法もあります。
stashが複数ある場合は、例えば、
git stash pop 'stash@{1}'のように、戻したいstashを指定することもできます。
stashの中身を見たいとき
戻す前に、
「何をstashしたんだっけ？」
と確認したいこともあります。
そんなときは、
git stash showで確認できます。
もう少し詳しく差分を見たいなら、
git stash show -pとすると、変更内容を見ることができます。
いきなり戻すのがちょっと不安なときに便利ですね。
新しく作ったファイルは少し注意
ここで一つ注意です。
通常の git stash は、Gitでまだ追跡されていない新しいファイルを、そのままではstashしません。
例えば、
new-file.txtを新しく作ったけれど、まだ git add していない場合です。
そういうファイルもstashしたい場合には、
git stash push -u -- new-file.txtのように、
-uを使う方法があります。
-u は、
--include-untrackedの短い書き方です。
include-untracked、「追跡されていないものを含む」の意味です。
「ファイルを指定したのにstashされないな」
と思ったときは、そのファイルがまだGitに追跡されていないものではないか確認してみるといいかもしれません。
変更の一部分だけstashしたい場合もあります
今回は、
ファイル単位
でstashしました。
でも、
「同じファイルの中でも、この変更だけよけたい」
ということもあります。
そんなときには、
git stash -pという方法もあります。
-p は変更箇所を見ながら、一つずつstashするかどうかを選べます。
これはまた少し違った使い方なので、別の機会にゆっくり見てみてもよさそうです。
僕自身、どんな動きをするのか興味津々です。
まとめ
今回は、特定のファイルだけを git stash する方法を見てみました。
一つのファイルなら、
git stash push -- src/User.php複数なら、
git stash push -- src/User.php src/Order.phpパターンでまとめて指定するなら、
git stash push -- 'src/*.php'と書けます。
stashしたものは、
git stash listで確認できます。
戻すときは、
git stash popまたは、
git stash applyです。
作業をしていると、
「全部をstashしたいわけじゃないんだよな」
ということがあります。
そんなときに、
git stash push -- ファイル名を知っていると、必要な変更だけ一旦よけることができます。
Gitは、少しずつ便利な使い方を覚えていくと、
「こういうこともできるんだ」
というものが結構あります。
また一つずつ見ていきましょう。
読んでくださってありがとうございました。
それではまた！