如何在Bash中创建带Git分支Tab补全参数的自定义命令？

一、实现git banana的分支Tab补全（不覆盖原有Git补全） #

Git官方Bash补全脚本支持扩展子命令补全，无需修改原脚本，只需在Shell配置文件（如~/.bashrc或~/.bash_profile）中添加以下配置：

1. 确保加载Git补全脚本
   如果还未加载，先添加此行（路径根据系统调整，常见路径为/usr/share/git-core/contrib/completion/git-completion.bash或/etc/bash_completion.d/git）：

   source /usr/share/git-core/contrib/completion/git-completion.bash
   

2. 编写自定义补全函数
   添加处理git banana的补全逻辑，支持跳过可选参数--optional-option后补全分支：

   __git_banana_completion() {
       local cur="${COMP_WORDS[COMP_CWORD]}"
       local prev="${COMP_WORDS[COMP_CWORD-1]}"
   
       # 处理--optional-option后的无参数场景
       if [[ "$prev" == "--optional-option" ]]; then
           COMPREPLY=()
           return
       fi
   
       # 判断当前位置是否需要补全分支
       case "$COMP_CWORD" in
           1)
               # 第一个位置参数直接补全分支
               __gitcomp "$(git branch --no-color --format='%(refname:short)' | tr '\n' ' ')"
               ;;
           2)
               # 如果第一个参数是--optional-option，第二个参数补全分支
               [[ "${COMP_WORDS[1]}" == "--optional-option" ]] && \
                   __gitcomp "$(git branch --no-color --format='%(refname:short)' | tr '\n' ' ')"
               ;;
           *)
               COMPREPLY=()
               ;;
       esac
   }
   

3. 注册补全函数到Git子命令
   用Git补全脚本提供的__git_complete函数注册，不会覆盖原有Git补全规则：

   __git_complete banana __git_banana_completion
   

保存配置后执行source ~/.bashrc生效，此时git banana或git banana --optional-option后按Tab即可补全分支。

二、利用Git内置Shell函数实现补全 #

Git官方补全脚本提供了多个辅助函数，__gitcomp是核心工具，具体用法如下：

1. __gitcomp的基本用法 #

__gitcomp接受空格分隔的候选字符串，会自动根据当前输入过滤生成补全结果。比如获取本地分支列表：

__gitcomp "$(git branch --no-color --format='%(refname:short)' | tr '\n' ' ')"

若需包含远程分支，可修改为：

__gitcomp "$(git branch -a --no-color --format='%(refname:short)' | tr '\n' ' ')"

2. 配合别名使用 #

如果有别名gb='git banana'，直接给别名绑定补全函数：

complete -F __git_banana_completion gb

3. 针对指定位置参数触发补全 #

在自定义补全函数中，通过COMP_CWORD（当前参数的索引）判断位置：

• COMP_CWORD=1对应git banana后的第一个参数
• 若存在--optional-option，则COMP_CWORD=2时触发分支补全（如前面的函数示例）

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