Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use native cobra zsh completion script generator instead of wrapper script #40

Merged
merged 2 commits into from
Oct 28, 2019
Merged

Use native cobra zsh completion script generator instead of wrapper script #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fd329a
Use native zsh completion from spf13/cobra
Oct 27, 2019
b485582
Add missing compdef call
Oct 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 6 additions & 187 deletions cmd/completion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

/*
NOTICE: The zsh wrapper code below is derived from the completion code
in kubectl (k8s.io/kubernetes/pkg/kubectl/cmd/completion/completion.go),
with the following license:

Copyright 2016 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cmd

import (
"bytes"
"fmt"
"io"

Expand All @@ -62,157 +41,7 @@ const (
Additionally, you may want to output the completion to a file and source in your .bashrc
`

zshInitialization = `#compdef rakkess

__rakkess_bash_source() {
alias shopt=':'
alias _expand=_bash_expand
alias _complete=_bash_comp
emulate -L sh
setopt kshglob noshglob braceexpand

source "$@"
}

__rakkess_type() {
# -t is not supported by zsh
if [ "$1" == "-t" ]; then
shift

# fake Bash 4 to disable "complete -o nospace". Instead
# "compopt +-o nospace" is used in the code to toggle trailing
# spaces. We don't support that, but leave trailing spaces on
# all the time
if [ "$1" = "__rakkess_compopt" ]; then
echo builtin
return 0
fi
fi
type "$@"
}

__rakkess_compgen() {
local completions w
completions=( $(compgen "$@") ) || return $?

# filter by given word as prefix
while [[ "$1" = -* && "$1" != -- ]]; do
shift
shift
done
if [[ "$1" == -- ]]; then
shift
fi
for w in "${completions[@]}"; do
if [[ "${w}" = "$1"* ]]; then
echo "${w}"
fi
done
}

__rakkess_compopt() {
true # don't do anything. Not supported by bashcompinit in zsh
}

__rakkess_ltrim_colon_completions()
{
if [[ "$1" == *:* && "$COMP_WORDBREAKS" == *:* ]]; then
# Remove colon-word prefix from COMPREPLY items
local colon_word=${1%${1##*:}}
local i=${#COMPREPLY[*]}
while [[ $((--i)) -ge 0 ]]; do
COMPREPLY[$i]=${COMPREPLY[$i]#"$colon_word"}
done
fi
}

__rakkess_get_comp_words_by_ref() {
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[${COMP_CWORD}-1]}"
words=("${COMP_WORDS[@]}")
cword=("${COMP_CWORD[@]}")
}

__rakkess_filedir() {
local RET OLD_IFS w qw

__rakkess_debug "_filedir $@ cur=$cur"
if [[ "$1" = \~* ]]; then
# somehow does not work. Maybe, zsh does not call this at all
eval echo "$1"
return 0
fi

OLD_IFS="$IFS"
IFS=$'\n'
if [ "$1" = "-d" ]; then
shift
RET=( $(compgen -d) )
else
RET=( $(compgen -f) )
fi
IFS="$OLD_IFS"

IFS="," __rakkess_debug "RET=${RET[@]} len=${#RET[@]}"

for w in ${RET[@]}; do
if [[ ! "${w}" = "${cur}"* ]]; then
continue
fi
if eval "[[ \"\${w}\" = *.$1 || -d \"\${w}\" ]]"; then
qw="$(__rakkess_quote "${w}")"
if [ -d "${w}" ]; then
COMPREPLY+=("${qw}/")
else
COMPREPLY+=("${qw}")
fi
fi
done
}

__rakkess_quote() {
if [[ $1 == \'* || $1 == \"* ]]; then
# Leave out first character
printf %q "${1:1}"
else
printf %q "$1"
fi
}

autoload -U +X bashcompinit && bashcompinit

# use word boundary patterns for BSD or GNU sed
LWORD='[[:<:]]'
RWORD='[[:>:]]'
if sed --help 2>&1 | grep -q GNU; then
LWORD='\<'
RWORD='\>'
fi

__rakkess_convert_bash_to_zsh() {
sed \
-e 's/declare -F/whence -w/' \
-e 's/_get_comp_words_by_ref "\$@"/_get_comp_words_by_ref "\$*"/' \
-e 's/local \([a-zA-Z0-9_]*\)=/local \1; \1=/' \
-e 's/flags+=("\(--.*\)=")/flags+=("\1"); two_word_flags+=("\1")/' \
-e 's/must_have_one_flag+=("\(--.*\)=")/must_have_one_flag+=("\1")/' \
-e "s/${LWORD}_filedir${RWORD}/__rakkess_filedir/g" \
-e "s/${LWORD}_get_comp_words_by_ref${RWORD}/__rakkess_get_comp_words_by_ref/g" \
-e "s/${LWORD}__ltrim_colon_completions${RWORD}/__rakkess_ltrim_colon_completions/g" \
-e "s/${LWORD}compgen${RWORD}/__rakkess_compgen/g" \
-e "s/${LWORD}compopt${RWORD}/__rakkess_compopt/g" \
-e "s/${LWORD}declare${RWORD}/builtin declare/g" \
-e "s/\\\$(type${RWORD}/\$(__rakkess_type/g" \
<<'BASH_COMPLETION_EOF'
`

zshTail = `
BASH_COMPLETION_EOF
}

__rakkess_bash_source <(__rakkess_convert_bash_to_zsh)
_complete rakkess 2>/dev/null
`
zshCompdef = "\ncompdef _rakkess rakkess\n"
)

var completionCmd = &cobra.Command{
Expand All @@ -233,7 +62,7 @@ var completionCmd = &cobra.Command{
case "bash":
err = rootCmd.GenBashCompletion(out)
case "zsh":
err = runCompletionZsh(out)
err = getZshCompletion(out)
}
if err != nil {
logrus.Fatal(err)
Expand All @@ -245,20 +74,10 @@ func init() {
rootCmd.AddCommand(completionCmd)
}

func runCompletionZsh(out io.Writer) error {
if _, err := io.WriteString(out, zshInitialization); err != nil {
return err
}
buf := new(bytes.Buffer)
if err := rootCmd.GenBashCompletion(buf); err != nil {
return err
}
if _, err := out.Write(buf.Bytes()); err != nil {
return err
}

if _, err := io.WriteString(out, zshTail); err != nil {
func getZshCompletion(out io.Writer) error {
if err := rootCmd.GenZshCompletion(out); err != nil {
return err
}
return nil
_, err := io.WriteString(out, zshCompdef)
return err
}
5 changes: 3 additions & 2 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"context"
"fmt"
"io"
"strings"

"github.com/corneliusweig/rakkess/pkg/rakkess"
"github.com/corneliusweig/rakkess/pkg/rakkess/constants"
Expand Down Expand Up @@ -108,8 +109,8 @@ func init() {

// AddRakkessFlags sets up common flags for subcommands.
func AddRakkessFlags(cmd *cobra.Command) {
cmd.Flags().StringSliceVar(&rakkessOptions.Verbs, constants.FlagVerbs, []string{"list", "create", "update", "delete"}, fmt.Sprintf("show access for verbs out of %s", constants.ValidVerbs))
cmd.Flags().StringVarP(&rakkessOptions.OutputFormat, constants.FlagOutput, "o", "icon-table", fmt.Sprintf("output format out of %s", constants.ValidOutputFormats))
cmd.Flags().StringSliceVar(&rakkessOptions.Verbs, constants.FlagVerbs, []string{"list", "create", "update", "delete"}, fmt.Sprintf("show access for verbs out of (%s)", strings.Join(constants.ValidVerbs, ", ")))
cmd.Flags().StringVarP(&rakkessOptions.OutputFormat, constants.FlagOutput, "o", "icon-table", fmt.Sprintf("output format out of (%s)", strings.Join(constants.ValidOutputFormats, ", ")))

rakkessOptions.ConfigFlags.AddFlags(cmd.Flags())
}
Expand Down