Zsh自动补全脚本参数与值关联问题求助

命令格式 #

cmd --help
cmd A -flagA1 X
cmd A -flagA2 Y
cmd B -flagB1 Z

X、Y、Z为固定值，取值由启用的子命令决定。

预期补全行为 #

cmd A <tab> → 显示X、Y
cmd A -<tab> → 显示flagA1、flagA2

当前脚本（存在问题） #

#compdef _cmd

_cmd () {
    typeset -A opt_args
    local state line curcontext="$curcontext" state_descr

    _arguments -C \
               ': :->command'  \
               ': :->subcmd' \
        && ret=0

    case $state in
        (command)
            local -a subcommands
            subcommands=(
                'A:Do A'
                'B:Do B'
            )
            _describe -t commands 'subcommands' subcommands && ret=0
            ;;
        (subcmd)
            case $line[1] in
                (A)
                    _cmd_A_cmd
                    ;;
                (B)
                    ;;
            esac
            ;;
    esac
}

_cmd_A_cmd () {
    typeset -A opt_args
    local state line curcontext="$curcontext" state_descr

    _arguments -C \
               ':: :->options'  \
               ': :->subcmd' \
        && ret=0
    case $state in
        (options)
            _arguments
                '-flagA1:the flag A1' \
                '-flagA2:flag A2'
                ;;
        (subcmd)
            _values "A subcommand"\
                'X[X option]' \
                'Y[Y option]'
            ;;
    esac
}

问题分析 #

脚本无法补全子命令A的flag，核心问题在于_cmd_A_cmd函数的逻辑错误：

1. 在options分支中单独调用_arguments时未正确传递参数，且这种用法不符合Zsh补全规范——_arguments需要一次性定义所有选项，而非分状态调用。
2. 初始的_arguments -C结构未正确区分选项和位置参数的处理优先级，导致Zsh无法识别需要补全flag的场景。

修正后的脚本 #

#compdef _cmd

_cmd () {
    typeset -A opt_args
    local state line curcontext="$curcontext"

    # 先处理子命令补全
    _arguments -C \
               ': :->command' \
        && ret=0

    case $state in
        (command)
            local -a subcommands
            subcommands=(
                'A:Do A'
                'B:Do B'
            )
            _describe -t commands 'subcommands' subcommands && ret=0
            ;;
    esac

    # 根据已输入的子命令调用对应补全逻辑
    case $line[1] in
        (A)
            _cmd_A_cmd
            ;;
        (B)
            # 为B子命令添加补全逻辑（参照A的实现）
            _arguments \
                '-flagB1:the flag B1' && ret=0
            _values "B subcommand" 'Z[Z option]' && ret=0
            ;;
    esac
}

_cmd_A_cmd () {
    typeset -A opt_args
    local state line curcontext="$curcontext"

    # 一次性定义所有选项，同时预留位置参数的处理分支
    _arguments -C \
               '-flagA1:the flag A1' \
               '-flagA2:flag A2' \
               '*:: :->pos_args' \
        && ret=0

    case $state in
        (pos_args)
            # 补全位置参数X/Y
            _values "A subcommand" \
                'X[X option]' \
                'Y[Y option]' && ret=0
            ;;
    esac
}

修正说明 #

1. 主_cmd函数中，先完成子命令补全，再根据已输入的子命令直接调用对应补全函数，简化了状态分支的处理逻辑，避免混乱。
2. _cmd_A_cmd函数中，将-flagA1、-flagA2直接写入_arguments的参数列表，当输入cmd A -<tab>时，Zsh会自动识别并展示这些flag选项。
3. 使用*:: :->pos_args匹配后续的位置参数，当输入cmd A <tab>时，进入pos_args分支调用_values补全X和Y。

修改后即可同时实现flag补全和位置参数补全的预期效果。

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