让 Shell 命令提示符显示 Git 分支名称

缘起

在本地环境( iTerm2 + zsh) 使用终端工具操作 Git 时, 能够显示"当前文件夹名称"以及" Git 分支名称"(如下图).

shell_git_01.jpg

这种设置非常有用, 尤其是需要频繁切换分支时, 能够避免操作错误的分支.
但是使用远程服务器和 Vagrant 虚拟机时没有这个功能.

解决

上网搜索, 在一个博客上找到解决方案.

在 Shell 的配置文件中添加下面代码:

function git-branch-name {
  git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3
}
function git-branch-prompt {
  local branch=`git-branch-name`
  if [ $branch ]; then printf " [%s]" $branch; fi
}
PS1="\u@\h \[\033[0;36m\]\W\[\033[0m\]\[\033[0;32m\]\$(git-branch-prompt)\[\033[0m\] \$ "

注意: 上面的 git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3 可以改成 git symbolic-ref --short -q HEAD, 更简洁, 而且测试有效. 谢谢风之去向_c305的建议;
为了让大家可以比较前后, 原来的代码就不修改了;

因为远程服务器使用的是 bash, 所以配置文件在 ~/.bashrc, 添加上面的代码之后, 输入 source ~/.bashrc 使配置立即生效.

PS. 可以通过echo $SHELL 命令可以查看系统当前使用的 Shell; 如果使用的是 /bin/zsh，配置文件在 ~/.zshrc, 使用 source ~/.bashrc 来使 zsh 的配置立即生效)

最终的效果是:

shell_git_02.jpg

解读代码

第 1 部分

function git-branch-name {
  git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3
}

git symbolic-ref 是 Git 的命令, 表示"符号引用 (symbolic reference), 指向目前所在的分支. 比如命令 git symbolic-ref HEAD 会输出当前的分支, 输出样式像这样: refs/heads/dev

命令执行有两种输出, 一种是正常输出, 一种是错误输出. shell 把正常输出标记为 1, 错误输出标记为 2.
在非 git 工作目录下，‘git symbolic-ref HEAD‘会输出一个错误.

而 /dev/null 文件在被用作重定向输出时, 表示输出被直接丢弃; 被用作重定向输入时, 表示文件结束.

那么 2>/dev/null 的作用就是:

在非 git 工作目录下，‘git symbolic-ref HEAD‘ 会输出一个错误, 错误会输出到 /dev/null, 即不显示
在 git 工作目录下, ‘git symbolic-ref HEAD‘ 会正常输出, 提示符会显示当前分支
也就是说"只有在 git 工作目录下时, 提示符才会显示当前分支, 否则什么都不显示"

cut 是 Shell 命令, 表示剪下文本文件的数据; cut -d"/" -f 3 表示分隔符是 /, 以此分隔符来识别分割文本, 取出第 3 段数据;

所以, git symbolic-ref HEAD 识别出的结果是 refs/heads/dev, cut 以 / 为分隔符分割文本, 分别是 refs 和 heads 和 dev, 然后取出第 3 段数据, 就是 dev(当前的分支名称)

第 2 部分

function git-branch-prompt {
  local branch=`git-branch-name`
  if [ $branch ]; then printf " [%s]" $branch; fi
}

local 在文档中的解释是:

The local command creates an [incr Tcl] object that is local to the current call frame. When the call frame goes away, the object is auto-matically deleted. This command is useful for creating objects that are local to a procedure.

那么 local 应该是用于声明"局部变量"的. 查阅资料得知, Shell 中函数定义的变量默认是"全局变量", 所以如果要声明"局部变量", 需要用 local 显示声明;

local branch=`git-branch-name`

是指把函数 git-branch-name 获得的值赋给 branch 变量;
注意, 在 Shell 中, 声明变量时不需要加 $, 而且 = 符号两边不能加空格, 在引用变量时, 则需要加上 $, 这就是为什么后面 if [ $branch ]; 需要加 $ 符号的原因.

if [ $branch ]; then printf " [%s]" $branch; fi 表示: 如果存在 $branch 变量, 则将该变量做为字符串打印出来; (PS: shell 的控制结构中, ifelse 判断语句的开头是 if, 结尾是 fi,

第 3 部分

PS1 是 Shell 中的一个特殊变量, 用来表示"提示符", 该变量的可选参数包括:

\d: 显示日期, 格式为"星期月日"
\h: 显示简写主机名。如默认主机名 "localhost"
\t: 显示 24 小时制时间, 格式为 "HH:MM:SS"
\T: 显示 12 小时制时间, 格式为 "HH:MM:SS"
\A: 显示 24 小时制时间, 格式为 "HH:MM"
\u: 显示当前用户名
\w: 显示当前所在目录的完整名称
\W: 显示当前所在目录的最后一个目录
\#: 执行的第几个命令
\$: 提示符, 如果是 root 用户会显示提示符为 "#", 如果是普通用户会显示提示符为 $

Shell 输出样式设置:

\33[0m 关闭所有属性
\33[1m 设置高亮度
\33[4m 下划线
\33[5m 闪烁
\33[7m 反显
\33[8m 消隐
\33[30m -- \33[37m 设置前景色
\33[40m -- \33[47m 设置背景色

所以 PS1="\u@\h \[\033[0;36m\]\W\[\033[0m\]\[\033[0;32m\]\$(git-branch-prompt)\[\033[0m\] \$ " 的解读如下:

组成部分是:

\u@\h 表示显示"当前用户名"和"主机名", 用 @ 符号连接;
\W 显示当前所在目录;
\$(git-branch-prompt) 表示使用前面 git-branch-prompt() 函数的结果;
最后一个 \$ 表示是 root 用户会显示提示符为 "#", 如果是普通用户会显示提示符为 $;

颜色设置是:

\[\033[0;36m\]\W\[\033[0m\] 剔除转义字符应该是 \033[0;36m \W \033[0m. 尝试打印 echo -e "\033[0;36m 我是目录名称 \033[0m", 输出结果是

shell_color_set_01.jpg
\[\033[0;32m\]\$(git-branch-prompt)\[\033[0m\]剔除转义字符应该是 \033[0;32m $(git-branch-prompt) \033[0m, 尝试打印echo -e "\033[0;32m 我是分支名称 \033[0m ", 输出结果是

shell_color_set_02.jpg

参考资料

git-setting-up-a-remote-repository-and-doing-an-initial-push
Bash变量
shell笔记-local、export用法
shell学习笔记
本文下面的留言 (风之去向_c305 的留言 )

文章历史

2017.04.30 第一次发布
2017.11.06 添加网友 tomhacker 对于 2>/dev/null 的解释, 谢谢 tomhacker
2018.01.16 根据网友风之去向_c305 的解释和建议进行修改; 谢谢风之去向_c305.

如果你觉得我的文章对你有用, 请打个"喜欢", 或者给些改进的建议 ^_

让 Shell 命令提示符显示 Git 分支名称