程序有子命令时完成

时间:2012-01-25 09:57:09

标签: zsh zsh-completion

我编写了一个命令行工具,它使用的子命令很像Mercurial,Git,Subversion& c。,因为它的一般用法是:

>myapp [OPTS] SUBCOMMAND [SUBCOMMAND-OPTS] [ARGS]

E.g。

>myapp --verbose speak --voice=samantha --quickly "hello there"

我现在正在为它建立Zsh完成,但很快发现它是一个非常复杂的野兽。我已经看过_hg_git完成但它们非常复杂且方法不同(我很难理解它们),但两者似乎都分别处理每个子命令。

有没有人知道是否有办法使用内置函数(_arguments_valuespick_variant& c。)来正确处理子命令的概念,包括处理适当的一般选项和子命令特定选项?或者最好的方法是手动处理一般选项和子命令?

非常感谢一个愚蠢的例子。

非常感谢。

1 个答案:

答案 0 :(得分:23)

你是对的,因为zsh的编写完成脚本可能非常困难。您最好的选择是使用现有的作为指导。对于初学者来说,git对于初学者来说太过分了。你可以使用这个仓库:

https://github.com/zsh-users/zsh-completions

至于你的问题,你使用了 state 的概念。您可以在列表中定义子命令,然后通过 $ state 识别您所在的命令。然后为每个命令定义选项。您可以在 play 的完成脚本中看到这一点。简化版如下:

_play() {
  local ret=1

  _arguments -C \
    '1: :_play_cmds' \
    '*::arg:->args' \
  && ret=0

  case $state in
    (args)
       case $line[1] in
         (build-module|list-modules|lm|check|id)
           _message 'no more arguments' && ret=0
         ;;
         (dependencies|deps)
           _arguments \
             '1:: :_play_apps' \
             '(--debug)--debug[Debug mode (even more informations logged than in verbose mode)]' \
             '(--jpda)--jpda[Listen for JPDA connection. The process will  suspended until a client is plugged to the JPDA port.]' \
             '(--sync)--sync[Keep lib/ and modules/ directory synced. Delete unknow dependencies.]' \
             '(--verbose)--verbose[Verbose Mode]' \
             && ret=0
         ;;
       esac
   esac

(如果你要粘贴它,请使用原始来源,因为这不起作用)。

看起来令人生畏,但总体思路并不复杂。子命令是第一个(_play_cmds是一个子命令列表,每个子命令都有一个描述),然后是参数。参数是根据您选择的子命令构建的。请注意,如果它们共享参数,则可以对多个子命令进行分组。

使用 man zshcompsys ,您可以找到有关整个系统的更多信息,尽管它有点密集。