ターミナルのプロンプトをカスタマイズ

Home
Project
ターミナルのプロンプトをカスタマイズ

概要

Gitのブランチ名を表示したり色付けしたりして、ターミナルのプロンプトをカスタマイズする。ここでのシェルはzshを想定している。

基本

ホームディレクトリにある.zshrcファイルに設定を追記してカスタマイズする。具体的には%nや%mのようなパラメータを組み合わせる。

1
PROMPT='%n@%m %~ %# '

以下のように出力される。

1
username@hostname ~/path/from/home_directory % ここにコマンドを入力
2
username@hostname ~/path/from/home_directory % ここにコマンドを入力
3
...

.zshrcファイルを更新した後は、exec $SHELL -lで新しいログインシェルを起動して反映を確認。

Gitのブランチ名を表示する

git-promptを使う。

ダウンロード

1
curl -o ~/.git-prompt.sh https://raw.githubusercontent.com/git/git/refs/heads/master/contrib/completion/git-prompt.sh

実装

.zshrcファイルに追記。プロンプトを見やすくするために、ユーザー名やパスの表示部分をそれぞれ関数化しておく。

1
# git-promptを読み込む
2
. ~/.git-prompt.sh
3

4
# gitの状態に応じて記号を表示する
5
GIT_PS1_SHOWDIRTYSTATE=true
6
GIT_PS1_SHOWSTASHSTATE=true
7
GIT_PS1_SHOWUNTRACKEDFILES=true
8

9
# gitの情報を表示する
10
current_git_info() {
11
  if [[ -d .git ]]; then
12
    __git_ps1 "%s"
13
  fi
14
}
15

16
username_and_hostname() {
17
  echo "%n@%m"
18
}
19

20
path_from_home() {
21
  echo "%~"
22
}
23

24
# プロンプトを表示する
25
setopt PROMPT_SUBST ; PS1='
26
$(username_and_hostname)
27
$(path_from_home) $(current_git_info) %# '

1
username@hostname
2
~/path/from/home_directory main % ここにコマンドを入力
3

4
username@hostname
5
~/path/from/home_directory main % ここにコマンドを入力
6

7
...

Gitのユーザー名を表示する

複数のgitユーザーを使い分ける場合に、自分が誰なのか？を調べる手間を省く。

1
...
2

3
current_git_user_name() {
4
  if [[ -d .git ]]; then
5
    echo "$(git config user.name)"
6
  fi
7
}
8

9
...
10

11
$(path_from_home) $(current_git_info) %# '
12
$(path_from_home) $(current_git_info) $(current_git_user_name) %# '

1
username@hostname
2
~/path/from/home_directory main git_username % ここにコマンドを入力
3

4
username@hostname
5
~/path/from/home_directory main git_username % ここにコマンドを入力
6

7
...

色をつける

文字色を変更する場合は%F{色番号}と%fで囲む。ハイライトする場合は%K{色番号}と%kで囲む。色番号について調べるとよく0〜7が出てくるが、それだと良い感じの色を指定できないこともあるので、256色で指定する。

ハイライトは余白が欲しくなるので、半角スペースを入れた。

1
...
2

3
adjusted_git_info() {
4
  if [[ -d .git ]]; then
5
    local result="$(current_git_info)"
6

7
    echo "%K{025} %F{254}${result}%f %k"
8
  fi
9
}
10

11
current_git_user_name() {
12
  if [[ -d .git ]]; then
13
    echo "$(git config user.name)"
14
    echo "%K{044} $(git config user.name) %k"
15
  fi
16
}
17

18
username_and_hostname() {
19
  echo "%n@%m"
20
  echo "%F{244}%n@%m%f"
21
}
22

23
path_from_home() {
24
  echo "%~"
25
  echo "%F{006}%~%f"
26
}
27

28
...
29

30
$(path_from_home) $(current_git_info) $(current_git_user_name) %# '
31
$(path_from_home) $(adjusted_git_info) $(current_git_user_name) %# '

gitの情報を微調整

ステージング状態で色分け。
gitの情報とユーザー名の間は半角スペースないほうが良い感じ。

1
...
2

3
adjusted_git_info() {
4
  if [[ -d .git ]]; then
5
    local result="$(current_git_info)"
6

7
    echo "%K{025} %F{254}${result}%f %k"
8
    # 未ステージングあり
9
    if echo "$result" | grep -q "*"; then
10
      echo "%K{009} %F{254}${result}%f %k"
11
    # すべてステージング済み
12
    elif echo "$result" | grep -q "+"; then
13
      echo "%K{010} ${result} %k"
14
    # 通常時
15
    else
16
      echo "%K{025} %F{254}${result}%f %k"
17
    fi
18
  fi
19
}
20

21
...
22

23
$(path_from_home) $(adjusted_git_info) $(current_git_user_name) %# '
24
$(path_from_home) $(adjusted_git_info)$(current_git_user_name) %# '

最終版

1
# ▼ プロンプトのカスタマイズ --------
2

3
# git-promptを読み込む
4
. ~/.git-prompt.sh
5

6
# gitの状態に応じて記号を表示する
7
GIT_PS1_SHOWDIRTYSTATE=true
8
GIT_PS1_SHOWSTASHSTATE=true
9
GIT_PS1_SHOWUNTRACKEDFILES=true
10

11
# gitの情報を表示する
12
current_git_info() {
13
  if [[ -d .git ]]; then
14
    __git_ps1 "%s"
15
  fi
16
}
17

18
adjusted_git_info() {
19
  if [[ -d .git ]]; then
20
    local result="$(current_git_info)"
21

22
    # 未ステージングあり
23
    if echo "$result" | grep -q "*"; then
24
      echo "%K{009} %F{254}${result}%f %k"
25
    # すべてステージング済み
26
    elif echo "$result" | grep -q "+"; then
27
      echo "%K{010} ${result} %k"
28
    # 通常時
29
    else
30
      echo "%K{025} %F{254}${result}%f %k"
31
    fi
32
  fi
33
}
34

35
current_git_user_name() {
36
  if [[ -d .git ]]; then
37
    echo "%K{044} $(git config user.name) %k"
38
  fi
39
}
40

41
username_and_hostname() {
42
  echo "%F{244}%n@%m%f"
43
}
44

45
path_from_home() {
46
  echo "%F{006}%~%f"
47
}
48

49
# プロンプトを表示する
50
setopt PROMPT_SUBST ; PS1='
51
$(username_and_hostname)
52
$(path_from_home) $(adjusted_git_info)$(current_git_user_name) %# '
53

54
# ▲ プロンプトのカスタマイズ --------

余談

git-promptで未追跡が%で表示されるのを?に置換したかったが、その後の表示で%fが溢れる？などうまくいかなかったので断念した。

1
# 未追跡は「%」ではなく「?」で表示
2
result=${result/\%/\?}

続く...かもね