👀

git branchで今いるブランチを確認する方法を卒業した

2022/10/15に公開

背景

開発していて、ふと「今いるブランチってどこやっけ?」って思うことありませんか??
僕は久しぶりに開いたリポジトリだったり少し作業時間が空くとよく思います。

そして、僕はその度にgit bを打って確認してました笑

なぜならその方法しか知らなかったから・・・

でも、いちいちコマンド打たなくてもいい方法を教わったので、タイトルの通り僕は今いるブランチを確認するためだけにコマンドを打つのを辞めました!

その方法とはターミナルに今いるブランチ名を表示させておくというものです(どーん)

過去の自分のようにコマンド打って確認している人向けにその設定方法を書いておこうと思いますー

今まで無駄にコマンド打って確認していた時間がこれからは無くなります。

設定後のターミナル

先に設定後にどんな感じになるのかというと、下記のようになります。

そう!ディレクトリ名の横に今いるブランチ名が表示されているのです!
こうしておけば、コマンドなんか打たなくてもすぐに今どこにいるのか分かりますよね。
しかも、色ついてるから見た目も綺麗でテンション上がりますよね!!!(僕は特には上がらないけど)

前提

  • 使用PCはMacBookProです
  • OSはmacOS Big Sur 11.3.1です
  • シェルはbashを使用しています
    • $ echo $SHELLで使用しているシェルを確認できます
    • zshに関しては最下部に参考サイトを載せています
  • ターミナルはVSCodeとiTermで試しています

設定方法

gitをインストールする

入ってるかどうかは

$ which git

で確認してみて、

/usr/local/bin/git

って表示されてたらOKです!

もし入ってない場合は

$ brew install git 

で入れてみてください。

必要ファイルを確認する

$ ls /usr/local/etc/bash_completion.d/

上記のコマンドでgit-completion.bashgit-prompt.shがあるか確認してみてください。

実行結果例:

brew                    gapplication            git-completion.bash     gsettings
brew-services           gdbus                   git-prompt.sh           npm
docker                  gio                     gresource

僕の場合は最初何故か無かったので、再度gitを入れ直したら入りました。
このファイルはHomebrewでgitを入れた場合に存在するらしいので、もしかすると違う方法で入れてたのかな?
使用PCにgit自体イントールしたのが2016年とかなので、どうやって入れたか忘れました笑

設定ファイルに記述をする

$ vi ~/.bashrc

で設定ファイルを開いてください。

そうするとファイルの中身が見れます(もし存在してなかったら新規作成される)

このままじゃ編集出来ないので、「i」を押してもらうと-- INSERT --と下記に表示されてファイルの編集が出来るようになります。

その後、下の記述を追記してください。

source /usr/local/etc/bash_completion.d/git-prompt.sh
source /usr/local/etc/bash_completion.d/git-completion.bash
if [ $UID -eq 0 ]; then
    PS1='\[\033[31m\]\u@\h\[\033[00m\]:\[\033[01m\]\w\[\033[31m\]$(__git_ps1)\[\033[00m\]\\$ '
else
    PS1='\[\033[36m\]\u@\h\[\033[00m\]:\[\033[01m\]\w\[\033[31m\]$(__git_ps1)\[\033[00m\]\\$ '
fi

もし色を変えたい場合は、31mみたいな箇所を変えれば変更出来たりするので、参考サイトを見てみるといいのかなーって思います!

設定を反映する

$ source ~/.bashrc

以上で設定は終了です。
後は、任意のリポジトリに移動してブランチ名が表示されているか確認してみてください!

尚、設定に関しては以下のサイトを参考にしました。
https://qiita.com/lemtosh469/items/334ff76366e054a3a3aa

zshの場合

zshに関しては、知人のPCで検証させてもらいましたが、以下のサイトを参考に設定できました。
https://shimi-shin.com/programming/environment/zsh-display-branch/

その際ググったワードは 「ターミナル ブランチ名 表示 zsh」 みたいな感じだった気がします。

Discussion