添加Git分支到Bash提示符后出现光标定位与命令异常问题

问题背景 #

在Bash命令行添加Git分支显示功能后，.bashrc配置代码如下：

parse_git_branch() {
git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/[\1] /'
}

PS1="\[${COLOR_LIGHT_RED}\]\d \t \[${COLOR_GREEN}\] \[\$(parse_git_branch)\]\[${COLOR_LIGHT_PURPLE}\]\w \[${COLOR_YELLOW}\]>> \[${COLOR_NC}\]"

显示效果符合预期，但存在异常行为：滚动至之前输入的长命令并按下Home键时，光标会定位到分支名称中间，输入内容会导致部分命令消失。

尝试将parse_git_branch修改为以下代码后，光标定位恢复正常，但这并非Bash的正确写法，需求是保留函数并让它返回空字符串：

parse_git_branch() {
echo
}

问题根源 #

Bash计算命令行长度时，会将\[与\]包裹的内容识别为非打印字符（不占用光标位置）。原配置中，parse_git_branch函数输出的分支名称属于打印字符，却被错误包裹在\[\$(parse_git_branch)\]中，导致Bash无法正确计算命令行实际长度，进而引发光标定位错误。

解决方案 #

方案1：修复Git分支显示的光标定位问题 #

修改parse_git_branch函数，将颜色控制码用\[和\]包裹，分支名称作为打印字符正常输出，同时调整PS1配置：

parse_git_branch() {
  local branch=$(git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/\1/')
  if [ -n "$branch" ]; then
    echo -e "\[${COLOR_GREEN}\][$branch] \[${COLOR_NC}\]"
  fi
}

PS1="\[${COLOR_LIGHT_RED}\]\d \t \$(parse_git_branch)\[${COLOR_LIGHT_PURPLE}\]\w \[${COLOR_YELLOW}\]>> \[${COLOR_NC}\]"

此配置下，Bash能准确区分打印字符与非打印字符，光标定位恢复正常。

方案2：让函数返回空字符串的正确写法 #

若仅需保留函数并返回空字符串，无需使用echo（echo会输出换行干扰提示符），使用Bash空命令:即可：

parse_git_branch() {
  :
}

:命令执行后无任何输出，完美实现返回空字符串的需求，且不会影响光标定位。

内容的提问来源于stack exchange，提问作者Matt