如何标准化维护bash与zsh的Shell补全？避免重复开发与手动配置

既然你已经有了现成的bash补全脚本，又不想维护两套代码，同时希望用户安装后无需手动配置，结合Homebrew的特性，最推荐的方案是利用zsh自带的bash补全兼容层，配合Homebrew的安装逻辑自动完成配置，完全满足你的需求。

核心思路 #

zsh内置了bashcompinit模块，可以让zsh直接加载并解析bash风格的补全脚本。我们只需要通过Homebrew把你的bash补全脚本安装到正确路径，再给zsh加一个极简的启动脚本，自动启用兼容层并加载补全，用户安装后无需任何手动操作就能在zsh中使用补全。

具体实现步骤 #

1. 保留现有bash补全脚本 #

假设你的bash补全脚本叫mytool-completion.bash，里面是已经写好的_mytool_completion()函数和complete -F _mytool_completion mytool命令，完全不需要修改它。

2. 编写极简的zsh兼容启动脚本 #

创建一个名为_mytool的zsh补全脚本（zsh补全脚本惯例以_开头），内容如下：

# 非交互式shell直接退出，避免不必要的加载
if [[ ! -o interactive ]]; then
    return
fi

# 初始化zsh补全系统
autoload -U compinit
compinit

# 启用bash补全兼容层
autoload -U bashcompinit
bashcompinit

# 加载Homebrew安装的bash补全脚本
source "$(brew --prefix)/etc/bash_completion.d/mytool"

3. 在Homebrew Formula中配置安装逻辑 #

在你的工具的Homebrew Formula（mytool.rb）的install块里，添加补全脚本的安装配置：

def install
  # 安装主程序（这里是你的原有安装逻辑）
  bin.install "mytool"

  # 安装bash补全到Homebrew默认的bash补全目录
  bash_completion.install "mytool-completion.bash" => "mytool"

  # 安装zsh补全脚本到Homebrew默认的zsh补全目录
  zsh_completion.install "_mytool"
end

为什么这是最优方案？ #

• 零额外维护成本：完全复用你已有的bash补全代码，不需要编写独立的zsh补全逻辑
• 用户无感知：Homebrew会自动把补全脚本放到正确的系统路径，zsh的启动脚本会自动处理兼容层，用户安装后新开终端就能直接用补全，不用手动修改~/.zshrc
• 符合社区规范：完全遵循Homebrew对bash/zsh补全的安装标准，不会有奇怪的自定义配置

备选方案：单文件兼容bash/zsh补全 #

如果你想更进一步，把补全逻辑整合到一个文件中（同时支持bash和zsh），可以编写一个兼容双shell的补全脚本，示例如下：

#!/usr/bin/env bash

# 判断当前shell类型，初始化对应补全系统
if [[ -n "$ZSH_VERSION" ]]; then
    autoload -U compinit && compinit
    autoload -U bashcompinit && bashcompinit
elif [[ -n "$BASH_VERSION" ]]; then
    # bash下无需额外初始化，除非你的脚本依赖特定设置
    shopt -s progcomp
fi

# 这里是你原有的bash补全逻辑，完全复用
_mytool_completion() {
    local cur="${COMP_WORDS[COMP_CWORD]}"
    COMPREPLY=()

    # 你的补全逻辑，比如生成候选列表
    COMPREPLY=($(compgen -W "command1 command2 --help --version" -- "$cur"))
}

# 注册补全函数到对应shell
if [[ -n "$BASH_VERSION" ]]; then
    complete -F _mytool_completion mytool
elif [[ -n "$ZSH_VERSION" ]]; then
    compdef _mytool_completion mytool
fi

这种方案下，你只需要维护这一个文件，在Homebrew Formula中同时安装到bash和zsh的补全目录即可：

bash_completion.install "mytool-completion.sh" => "mytool"
zsh_completion.install "mytool-completion.sh" => "_mytool"

不过这种方案需要确保你的bash补全逻辑没有使用zsh不兼容的bash特定语法（比如某些数组操作、[[之外的条件判断），如果原有补全比较复杂，可能需要少量调整。

注意事项 #

• 测试时，安装工具后记得新开终端，确保补全系统已经加载
• 如果你的bash补全使用了较复杂的bash特性（比如mapfile、BASH_ARGV等），可能需要微调以适配zsh的bashcompinit兼容层，不过大部分常用补全逻辑都能直接兼容

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