はじめに

git で現在の作業を退避（stash）するとき、
今までは $ git stash -u や git stash save {コメント}を使っていました。

しかしながら、退避コメント付与したい時や特定ファイルのみ退避したいときに、
オプションを忘れてググったり、うまくできずに手間取ることがよくありました。

そんな中、git stash pushというコマンドがあることを最近知り、
結構便利に感じたので自分用の備忘もかねて紹介します。

使い方

一番使う退避コマンド

個人的には、今後退避時はこのコマンドだけ使うことになりそうです。

# 退避対象ファイルをgitステージしておく
$ git stash push -m {コメントをここに} -S

少し詳しく

これだけだと寂しいので（自分もオプションの意味とか忘れそう）、
git stash pushの使い方を少し説明します。

基本文法

# 追跡済みのファイル と ステージ済みのファイルを　退避
$ git stash push

# 追跡やステージ関わらず全ファイルを退避（.gitignoreされていないファイルも含む）
$ git stash push -a

# 追跡やステージ関わらず全ファイルを退避（.gitignoreされていないファイルは除く）
$ git stash push -u

#  特定のファイルのみ退避
$ git stash push -- {ファイルパス}

コメント付与や特定ファイルのみ退避したいとき

ファイルパスの指定や変更分の一部ファイルだけを退避したい時に、上記だと面倒です。
そこで、退避したいファイルをステージした後、stash するのが一番楽だと思いました。

# 退避したいファイルをステージに追加 （自分はVSCodeでやる）
# cliでやるなら以下
$ git add file1 file2 file3

#  ステージしたファイルをすべて退避
$ git stash push -S

# コメントも残したい時
$ git stash push -m {コメントをここに} -S

ちなみに-Sではステージ済みであれば、-u（--include-untracked）をつけなくても未追跡ファイルも退避してくれます。

まとめ

$ git stash push -m {コメントをここに} -S

stash はよく使うけど毎回オプションを忘れてしまうという方はこれがオススメです！

参考