我有一个脚本myscript
需要两个参数:
- 主机名
- 目录
我如何编写自己的 zsh 补全,以便每当我这样做时
mysript <TAB>
它从我的主机列表中完成(即与ssh
所做的相同),当我这样做时
mysript host1 <TAB>
它从/home/martin/test/
?中的目录完成
答案1
谢谢你提出这个有趣的问题。我想在我的脚本中做同样的事情。这文档晦涩难懂,不太容易理解;我还没有学会如何在脚本中没有实际选项的情况下工作。这是我第一次尝试通过实际选项来实现目标。
首先,我创建了一个名为的 shell 脚本myscript.sh
,它使用选项。
#!/usr/bin/env sh
self=$(basename "$0")
hflag=0 # Boolean: hflag is not yet detected
dflag=0 # Boolean: dflag is not yet detected
function usage() {
echo "Usage: $self [ -h <hostname> | -d <directory> ]"
}
# If no options were given, exit with message and code.
if (($# == 0)); then
usage
exit 1
fi
# Process options and option arguments.
while getopts ":h:d:" option; do
case "${option}" in
h ) hflag=1 # The h option was used.
host=${OPTARG} # The argument to the h option.
;;
d ) dflag=1 # The d option was used.
dir=${OPTARG} # The argument to the d option.
;;
\?) # An invalid option was detected.
usage
exit 1
;;
: ) # An option was given without an option argument.
echo "Invalid option: $OPTARG requires an argument" 1>&2
exit 1
;;
esac
done
# One of hflag or dflag was missing.
if [ $hflag -eq 0 ] || [ $dflag -eq 0 ]; then
usage
exit 1
fi
# Do something with $host and $dir.
# This is where the actions of your current script should be placed.
# Here, I am just printing them.
echo "$host"
echo "$dir"
# Unset variables used in the script.
unset self
unset hflag
unset dflag
接下来,我确定了在哪里zsh
寻找自动完成文件。
print -rl -- $fpath
/usr/local/share/zsh/site-functions
就我而言,我选择了其中一个目录。被视为自动完成文件的文件名以下划线_字符开头。我_myscript
在目录中创建了文件。之后的部分#compdef
是上面的实际脚本名称。
#compdef myscript.sh
_myscript() {
_arguments '-h[host]:hosts:_hosts' '-d[directory]:directories:_directories'
}
_myscript "$@"
然后我执行compinit
以获取_myscript
文件提供的新自动完成定义。结果是,我现在可以使用制表符补全来指定-h
选项后的主机和选项后的目录,-d
同时在脚本本身的选项和选项参数的解析中仍然保持一定的理智。选项卡补全功能甚至在调用之前就会显示可用选项,myscript.sh
并使选项顺序无关。
用法如下。
myscript.sh -h <TAB> -d ~/test/<TAB>
总结解决方案
在第二次尝试中,我创建了一个简单的 shell 脚本zscript.sh
.
#!/usr/bin/env sh
echo "$1"
echo "$2"
我创建了一个文件,/usr/local/share/zsh/site-functions/_zscript
.
#compdef zscript.sh
_zscript() {
_arguments '1: :->hostname' '2: :->directory'
case $state in
hostname)
_hosts
;;
directory)
_directories -W $HOME/test/
;;
esac
}
我执行了compinit
。