提交 894210c3 编写于 作者: L lixiang 提交者: DCCooper

hack: add shell completion

Signed-off-by: NDCCooper <1866858@gmail.com>
上级 0cef71e6
......@@ -105,5 +105,15 @@ func addCommands(cmd *cobra.Command) {
NewLoginCmd(),
NewLogoutCmd(),
NewInfoCmd(),
completionCmd,
)
}
// "completion" command to generate bash completion script
var completionCmd = &cobra.Command{
Use: "completion",
Hidden: true,
Run: func(cmd *cobra.Command, args []string) {
cmd.Root().GenBashCompletion(os.Stdout) // nolint
},
}
......@@ -64,9 +64,25 @@ func newDaemonCommand() *cobra.Command {
rootCmd.PersistentFlags().BoolP("version", "v", false, "Version for isula-build daemon")
rootCmd.SetFlagErrorFunc(util.FlagErrorFunc)
addCommands(rootCmd)
return rootCmd
}
func addCommands(cmd *cobra.Command) {
cmd.AddCommand(
completionCmd,
)
}
var completionCmd = &cobra.Command{
Use: "completion",
Hidden: true,
Run: func(cmd *cobra.Command, args []string) {
cmd.Root().GenBashCompletion(os.Stdout) // nolint
},
}
func runDaemon(cmd *cobra.Command, args []string) error {
store, err := store.GetStore()
if err != nil {
......
此差异已折叠。
# bash completion for isula-builder -*- shell-script -*-
# To enable the completions for bash, place this file in "/etc/bash_completion.d"
# or just "source" it for temporary use
__isula-builder_debug()
{
if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then
echo "$*" >> "${BASH_COMP_DEBUG_FILE}"
fi
}
# Homebrew on Macs have version 1.3 of bash-completion which doesn't include
# _init_completion. This is a very minimal version of that function.
__isula-builder_init_completion()
{
COMPREPLY=()
_get_comp_words_by_ref "$@" cur prev words cword
}
__isula-builder_index_of_word()
{
local w word=$1
shift
index=0
for w in "$@"; do
[[ $w = "$word" ]] && return
index=$((index+1))
done
index=-1
}
__isula-builder_contains_word()
{
local w word=$1; shift
for w in "$@"; do
[[ $w = "$word" ]] && return
done
return 1
}
__isula-builder_handle_go_custom_completion()
{
__isula-builder_debug "${FUNCNAME[0]}: cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}"
local out requestComp lastParam lastChar comp directive args
# Prepare the command to request completions for the program.
# Calling ${words[0]} instead of directly isula-builder allows to handle aliases
args=("${words[@]:1}")
requestComp="${words[0]} __completeNoDesc ${args[*]}"
lastParam=${words[$((${#words[@]}-1))]}
lastChar=${lastParam:$((${#lastParam}-1)):1}
__isula-builder_debug "${FUNCNAME[0]}: lastParam ${lastParam}, lastChar ${lastChar}"
if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then
# If the last parameter is complete (there is a space following it)
# We add an extra empty parameter so we can indicate this to the go method.
__isula-builder_debug "${FUNCNAME[0]}: Adding extra empty parameter"
requestComp="${requestComp} \"\""
fi
__isula-builder_debug "${FUNCNAME[0]}: calling ${requestComp}"
# Use eval to handle any environment variables and such
out=$(eval "${requestComp}" 2>/dev/null)
# Extract the directive integer at the very end of the output following a colon (:)
directive=${out##*:}
# Remove the directive
out=${out%:*}
if [ "${directive}" = "${out}" ]; then
# There is not directive specified
directive=0
fi
__isula-builder_debug "${FUNCNAME[0]}: the completion directive is: ${directive}"
__isula-builder_debug "${FUNCNAME[0]}: the completions are: ${out[*]}"
if [ $((directive & 1)) -ne 0 ]; then
# Error code. No completion.
__isula-builder_debug "${FUNCNAME[0]}: received error from custom completion go code"
return
else
if [ $((directive & 2)) -ne 0 ]; then
if [[ $(type -t compopt) = "builtin" ]]; then
__isula-builder_debug "${FUNCNAME[0]}: activating no space"
compopt -o nospace
fi
fi
if [ $((directive & 4)) -ne 0 ]; then
if [[ $(type -t compopt) = "builtin" ]]; then
__isula-builder_debug "${FUNCNAME[0]}: activating no file completion"
compopt +o default
fi
fi
while IFS='' read -r comp; do
COMPREPLY+=("$comp")
done < <(compgen -W "${out[*]}" -- "$cur")
fi
}
__isula-builder_handle_reply()
{
__isula-builder_debug "${FUNCNAME[0]}"
local comp
case $cur in
-*)
if [[ $(type -t compopt) = "builtin" ]]; then
compopt -o nospace
fi
local allflags
if [ ${#must_have_one_flag[@]} -ne 0 ]; then
allflags=("${must_have_one_flag[@]}")
else
allflags=("${flags[*]} ${two_word_flags[*]}")
fi
while IFS='' read -r comp; do
COMPREPLY+=("$comp")
done < <(compgen -W "${allflags[*]}" -- "$cur")
if [[ $(type -t compopt) = "builtin" ]]; then
[[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace
fi
# complete after --flag=abc
if [[ $cur == *=* ]]; then
if [[ $(type -t compopt) = "builtin" ]]; then
compopt +o nospace
fi
local index flag
flag="${cur%=*}"
__isula-builder_index_of_word "${flag}" "${flags_with_completion[@]}"
COMPREPLY=()
if [[ ${index} -ge 0 ]]; then
PREFIX=""
cur="${cur#*=}"
${flags_completion[${index}]}
if [ -n "${ZSH_VERSION}" ]; then
# zsh completion needs --flag= prefix
eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )"
fi
fi
fi
return 0;
;;
esac
# check if we are handling a flag with special work handling
local index
__isula-builder_index_of_word "${prev}" "${flags_with_completion[@]}"
if [[ ${index} -ge 0 ]]; then
${flags_completion[${index}]}
return
fi
# we are parsing a flag and don't have a special handler, no completion
if [[ ${cur} != "${words[cword]}" ]]; then
return
fi
local completions
completions=("${commands[@]}")
if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then
completions=("${must_have_one_noun[@]}")
elif [[ -n "${has_completion_function}" ]]; then
# if a go completion function is provided, defer to that function
completions=()
__isula-builder_handle_go_custom_completion
fi
if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then
completions+=("${must_have_one_flag[@]}")
fi
while IFS='' read -r comp; do
COMPREPLY+=("$comp")
done < <(compgen -W "${completions[*]}" -- "$cur")
if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then
while IFS='' read -r comp; do
COMPREPLY+=("$comp")
done < <(compgen -W "${noun_aliases[*]}" -- "$cur")
fi
if [[ ${#COMPREPLY[@]} -eq 0 ]]; then
if declare -F __isula-builder_custom_func >/dev/null; then
# try command name qualified custom func
__isula-builder_custom_func
else
# otherwise fall back to unqualified for compatibility
declare -F __custom_func >/dev/null && __custom_func
fi
fi
# available in bash-completion >= 2, not always present on macOS
if declare -F __ltrim_colon_completions >/dev/null; then
__ltrim_colon_completions "$cur"
fi
# If there is only 1 completion and it is a flag with an = it will be completed
# but we don't want a space after the =
if [[ "${#COMPREPLY[@]}" -eq "1" ]] && [[ $(type -t compopt) = "builtin" ]] && [[ "${COMPREPLY[0]}" == --*= ]]; then
compopt -o nospace
fi
}
# The arguments should be in the form "ext1|ext2|extn"
__isula-builder_handle_filename_extension_flag()
{
local ext="$1"
_filedir "@(${ext})"
}
__isula-builder_handle_subdirs_in_dir_flag()
{
local dir="$1"
pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
}
__isula-builder_handle_flag()
{
__isula-builder_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
# if a command required a flag, and we found it, unset must_have_one_flag()
local flagname=${words[c]}
local flagvalue
# if the word contained an =
if [[ ${words[c]} == *"="* ]]; then
flagvalue=${flagname#*=} # take in as flagvalue after the =
flagname=${flagname%=*} # strip everything after the =
flagname="${flagname}=" # but put the = back
fi
__isula-builder_debug "${FUNCNAME[0]}: looking for ${flagname}"
if __isula-builder_contains_word "${flagname}" "${must_have_one_flag[@]}"; then
must_have_one_flag=()
fi
# if you set a flag which only applies to this command, don't show subcommands
if __isula-builder_contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then
commands=()
fi
# keep flag value with flagname as flaghash
# flaghash variable is an associative array which is only supported in bash > 3.
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
if [ -n "${flagvalue}" ] ; then
flaghash[${flagname}]=${flagvalue}
elif [ -n "${words[ $((c+1)) ]}" ] ; then
flaghash[${flagname}]=${words[ $((c+1)) ]}
else
flaghash[${flagname}]="true" # pad "true" for bool flag
fi
fi
# skip the argument to a two word flag
if [[ ${words[c]} != *"="* ]] && __isula-builder_contains_word "${words[c]}" "${two_word_flags[@]}"; then
__isula-builder_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
c=$((c+1))
# if we are looking for a flags value, don't show commands
if [[ $c -eq $cword ]]; then
commands=()
fi
fi
c=$((c+1))
}
__isula-builder_handle_noun()
{
__isula-builder_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
if __isula-builder_contains_word "${words[c]}" "${must_have_one_noun[@]}"; then
must_have_one_noun=()
elif __isula-builder_contains_word "${words[c]}" "${noun_aliases[@]}"; then
must_have_one_noun=()
fi
nouns+=("${words[c]}")
c=$((c+1))
}
__isula-builder_handle_command()
{
__isula-builder_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
local next_command
if [[ -n ${last_command} ]]; then
next_command="_${last_command}_${words[c]//:/__}"
else
if [[ $c -eq 0 ]]; then
next_command="_isula-builder_root_command"
else
next_command="_${words[c]//:/__}"
fi
fi
c=$((c+1))
__isula-builder_debug "${FUNCNAME[0]}: looking for ${next_command}"
declare -F "$next_command" >/dev/null && $next_command
}
__isula-builder_handle_word()
{
if [[ $c -ge $cword ]]; then
__isula-builder_handle_reply
return
fi
__isula-builder_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
if [[ "${words[c]}" == -* ]]; then
__isula-builder_handle_flag
elif __isula-builder_contains_word "${words[c]}" "${commands[@]}"; then
__isula-builder_handle_command
elif [[ $c -eq 0 ]]; then
__isula-builder_handle_command
elif __isula-builder_contains_word "${words[c]}" "${command_aliases[@]}"; then
# aliashash variable is an associative array which is only supported in bash > 3.
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
words[c]=${aliashash[${words[c]}]}
__isula-builder_handle_command
else
__isula-builder_handle_noun
fi
else
__isula-builder_handle_noun
fi
__isula-builder_handle_word
}
_isula-builder_root_command()
{
last_command="isula-builder"
command_aliases=()
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--config=")
two_word_flags+=("--config")
two_word_flags+=("-c")
flags+=("--dataroot=")
two_word_flags+=("--dataroot")
flags+=("--debug")
flags+=("-D")
flags+=("--help")
flags+=("-h")
flags+=("--log-level=")
two_word_flags+=("--log-level")
flags+=("--runroot=")
two_word_flags+=("--runroot")
flags+=("--storage-driver=")
two_word_flags+=("--storage-driver")
flags+=("--storage-opt=")
two_word_flags+=("--storage-opt")
flags+=("--version")
flags+=("-v")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
__start_isula-builder()
{
local cur prev words cword
declare -A flaghash 2>/dev/null || :
declare -A aliashash 2>/dev/null || :
if declare -F _init_completion >/dev/null 2>&1; then
_init_completion -s || return
else
__isula-builder_init_completion -n "=" || return
fi
local c=0
local flags=()
local two_word_flags=()
local local_nonpersistent_flags=()
local flags_with_completion=()
local flags_completion=()
local commands=("isula-builder")
local must_have_one_flag=()
local must_have_one_noun=()
local has_completion_function
local last_command
local nouns=()
__isula-builder_handle_word
}
if [[ $(type -t compopt) = "builtin" ]]; then
complete -o default -F __start_isula-builder isula-builder
else
complete -o default -o nospace -F __start_isula-builder isula-builder
fi
# ex: ts=4 sw=4 et filetype=sh
#compdef _isula-build isula-build
# To enable the completions for zsh, place this file in "/usr/share/zsh/site-functions" and do the command: autoload -Uz compinit && compinit
function _isula-build {
local -a commands
_arguments -C \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]' \
"1: :->cmnds" \
"*::arg:->args"
case $state in
cmnds)
commands=(
"ctr-img:Container Image Operations"
"info:Show isula-build system information"
"login:Login to an image registry"
"logout:Logout from an image registry"
"version:Show the isula-build version information"
)
_describe "command" commands
;;
esac
case "$words[1]" in
ctr-img)
_isula-build_ctr-img
;;
info)
_isula-build_info
;;
login)
_isula-build_login
;;
logout)
_isula-build_logout
;;
version)
_isula-build_version
;;
esac
}
function _isula-build_ctr-img {
local -a commands
_arguments -C \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]' \
"1: :->cmnds" \
"*::arg:->args"
case $state in
cmnds)
commands=(
"build:Build container images"
"images:List locally stored images"
"import:Import the base image from a tarball to the image store"
"load:Load images"
"rm:Remove one or more locally stored images"
"save:Save image to tarball"
"tag:create a tag for source image"
)
_describe "command" commands
;;
esac
case "$words[1]" in
build)
_isula-build_ctr-img_build
;;
images)
_isula-build_ctr-img_images
;;
import)
_isula-build_ctr-img_import
;;
load)
_isula-build_ctr-img_load
;;
rm)
_isula-build_ctr-img_rm
;;
save)
_isula-build_ctr-img_save
;;
tag)
_isula-build_ctr-img_tag
;;
esac
}
function _isula-build_ctr-img_build {
_arguments \
'*--build-arg[Arguments used during build time]:' \
'--build-static[Static build with the given option]:' \
'(-f --filename)'{-f,--filename}'[Path for Dockerfile]:' \
'--iidfile[Write image ID to the file]:' \
'(-o --output)'{-o,--output}'[Destination of output images]:' \
'--proxy[Inherit proxy environment variables from host]' \
'--tag[Add tag to the built image]:' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_images {
_arguments \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_import {
_arguments \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_load {
_arguments \
'(-i --input)'{-i,--input}'[Path to local tarball]:' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_rm {
_arguments \
'(-a --all)'{-a,--all}'[Remove all images]' \
'(-p --prune)'{-p,--prune}'[Remove all untagged images]' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_save {
_arguments \
'(-o --output)'{-o,--output}'[Path to save the tarball]:' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_ctr-img_tag {
_arguments \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_info {
_arguments \
'(-H --human-readable)'{-H,--human-readable}'[print memory info in human readable format, use powers of 1000]' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_login {
_arguments \
'(-p --password-stdin)'{-p,--password-stdin}'[Read password from stdin]' \
'(-u --username)'{-u,--username}'[Username to access registry]:' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_logout {
_arguments \
'(-a --all)'{-a,--all}'[Logout all registries]' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
function _isula-build_version {
_arguments \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'(-t --timeout)'{-t,--timeout}'[Timeout for connecting to daemon]:' \
'(-v --version)'{-v,--version}'[Version for isula-build client]'
}
#compdef _isula-builder isula-builder
# To enable the completions for zsh, place this file in "/usr/share/zsh/site-functions" and do the command: autoload -Uz compinit && compinit
function _isula-builder {
_arguments \
'(-c --config)'{-c,--config}'[Config file path]:' \
'--dataroot[Persistent dir]:' \
'(-D --debug)'{-D,--debug}'[Open debug mode]' \
'(-h --help)'{-h,--help}'[Print usage]' \
'--log-level[Log level to be used. Either "debug", "info", "warn" or "error"]:' \
'--runroot[Runtime dir]:' \
'--storage-driver[Storage-driver]:' \
'*--storage-opt[Storage driver option]:' \
'(-v --version)'{-v,--version}'[Version for isula-build daemon]'
}
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册