ターミナルの$記号前に、Gitの現在のブランチ名を表示する方法

どのブランチで作業しているのか分からなくなり、 とりあえずgit branchコマンドを実行する。

非常に無駄ですよね。
以前ターミナルの$記号前を自由に変更する記事を書きましたが、今回はそこからステップアップして、Gitの現在のブランチ名も表示するようにしてみたいと思います。

Webrandum

ターミナルの$記号前の表示を自由にカスタマイズする

https://webrandum.net/terminal-prompt-name

何も設定していないデフォルトの状態ではターミナルを起動すると、$記号の前に下記のような表示がされています。namae-no-Macbookair: namae $自分のmacの名前と、その後に自分のユーザー名ですね。今回はこのプロンプトを自分なりにカスタマイズする方法についてです。変更する方法変更方法はユーザーディレクトリに「.bash_profile」という名前のファイルを作成し、そこに下記コードを保存するだけです。PS1="ここに表示させたい内容を書く $"「表示させたい内容を書く」という部分には単純にテキストを書く事も可能ですし...

Gitのインストール

まず、GitのインストールはHomebrewを使った方が、ダウンロードされるパスなどの関係から良さそうです。
Homebrewの導入方法は以前書いた記事を参考にして下さい。

$ brew install git

which gitコマンドで、Homebrewで入れたGitが使われているかどうか確認します。
「/usr/local/bin/git」が返ってくればOKです。

$ which git
/usr/local/bin/git

変更の仕方

おさらいですが、$記号前を変更するにはホームディレクトリの.bashsrcファイルにあるPS1=の部分を変更します（なければ追加）。

PS1="ここに表示させたい内容を書く $"

今回の場合は追加でGitのブランチ名を表示させたいので、PS1=の前にGitの情報を取得する記述を書いておきます。
その後PS1=に__git_ps1を入力すればブランチ名が出力されるようになります。

.bashsrcsource /usr/local/etc/bash_completion.d/git-prompt.sh
source /usr/local/etc/bash_completion.d/git-completion.bash
GIT_PS1_SHOWDIRTYSTATE=true
PS1="\W$(__git_ps1) $"

保存してターミナルを再起動すれば、Gitが使用されているディレクトリでは「ディレクトリ名 (ブランチ名) $」の形式で表示されているはずです。

エラーが出る場合

__git_ps1: command not foundというエラーが表示される場合は、Gitの情報がうまく取得されていません。
下記の読み込み先のパスに間違いがないか確認してください。

.bashsrcsource /usr/local/etc/bash_completion.d/git-prompt.sh
source /usr/local/etc/bash_completion.d/git-completion.bash

もしくは、Homebrewで入れたGitが使われているかどうか確認してください。

まとめ

これで、わざわざgit branchを実行する必要がなくなりますし、「別のブランチで作業してしまっていた」なんて事も防止できますね。