PowerShellのプロンプトでgitのブランチ名を表示する方法（ついでに色も付ける）

COLUMN コラム

2021年08月28日
PowerShellのプロンプトでgitのブランチ名を表示する方法（ついでに色も付ける）

こんにちは。フリーランスエンジニアのsawadaです。

PowerShellを使っていて、いちいちgit branchでブランチ名を確認するのが面倒だったので、常にブランチ名を表示するようプロンプトの設定を変更してみました。（ついでにちょっとだけ色も付けてみました。）

↓こんな感じ。

[C:\Users\ユーザ名\git-dir] (master)
$

忘れないために、以下に設定手順をまとめておきます。

設定ファイル用のフォルダ作成
以下のフォルダが存在しない場合、フォルダを作成します。
C:\Users\ユーザ名\Documents\WindowsPowerShell
設定ファイルの作成
1.で作成したフォルダ内に、以下のファイルを作成します。
Microsoft.PowerShell_profile.ps1

設定ファイルの編集
2.で作成したファイルに、以下の設定を追記する。

function prompt {
  $branch = ""
  if (git branch) {
    (git branch | select-string "^\*").ToString() | set-variable -name branch
    $branch = $branch.trim() -replace "^\* *", ""
  }
  Write-Host("[") -NoNewline -ForegroundColor White
  Write-Host($(get-location)) -NoNewline -ForegroundColor Cyan
  Write-Host("]") -NoNewline -ForegroundColor White
  if ($branch -ne "") {
    Write-Host(" (") -NoNewline -ForegroundColor White
    Write-Host($branch) -NoNewline -ForegroundColor Yellow
    Write-Host(")") -NoNewline -ForegroundColor White
  }
  return "`n$ "
}