summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/spf13/cobra/bash_completions.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/spf13/cobra/bash_completions.go')
-rw-r--r--vendor/github.com/spf13/cobra/bash_completions.go272
1 files changed, 82 insertions, 190 deletions
diff --git a/vendor/github.com/spf13/cobra/bash_completions.go b/vendor/github.com/spf13/cobra/bash_completions.go
index a0d040279..e0cfb3494 100644
--- a/vendor/github.com/spf13/cobra/bash_completions.go
+++ b/vendor/github.com/spf13/cobra/bash_completions.go
@@ -1,6 +1,7 @@
package cobra
import (
+ "bytes"
"fmt"
"io"
"os"
@@ -18,12 +19,9 @@ const (
BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir"
)
-func preamble(out io.Writer, name string) error {
- _, err := fmt.Fprintf(out, "# bash completion for %-36s -*- shell-script -*-\n", name)
- if err != nil {
- return err
- }
- preamStr := `
+func writePreamble(buf *bytes.Buffer, name string) {
+ buf.WriteString(fmt.Sprintf("# bash completion for %-36s -*- shell-script -*-\n", name))
+ buf.WriteString(`
__debug()
{
if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then
@@ -134,7 +132,10 @@ __handle_reply()
declare -F __custom_func >/dev/null && __custom_func
fi
- __ltrim_colon_completions "$cur"
+ # available in bash-completion >= 2, not always present on macOS
+ if declare -F __ltrim_colon_completions >/dev/null; then
+ __ltrim_colon_completions "$cur"
+ fi
}
# The arguments should be in the form "ext1|ext2|extn"
@@ -247,18 +248,13 @@ __handle_word()
__handle_word
}
-`
- _, err = fmt.Fprint(out, preamStr)
- return err
+`)
}
-func postscript(w io.Writer, name string) error {
+func writePostscript(buf *bytes.Buffer, name string) {
name = strings.Replace(name, ":", "__", -1)
- _, err := fmt.Fprintf(w, "__start_%s()\n", name)
- if err != nil {
- return err
- }
- _, err = fmt.Fprintf(w, `{
+ buf.WriteString(fmt.Sprintf("__start_%s()\n", name))
+ buf.WriteString(fmt.Sprintf(`{
local cur prev words cword
declare -A flaghash 2>/dev/null || :
if declare -F _init_completion >/dev/null 2>&1; then
@@ -282,197 +278,132 @@ func postscript(w io.Writer, name string) error {
__handle_word
}
-`, name)
- if err != nil {
- return err
- }
- _, err = fmt.Fprintf(w, `if [[ $(type -t compopt) = "builtin" ]]; then
+`, name))
+ buf.WriteString(fmt.Sprintf(`if [[ $(type -t compopt) = "builtin" ]]; then
complete -o default -F __start_%s %s
else
complete -o default -o nospace -F __start_%s %s
fi
-`, name, name, name, name)
- if err != nil {
- return err
- }
- _, err = fmt.Fprintf(w, "# ex: ts=4 sw=4 et filetype=sh\n")
- return err
+`, name, name, name, name))
+ buf.WriteString("# ex: ts=4 sw=4 et filetype=sh\n")
}
-func writeCommands(cmd *Command, w io.Writer) error {
- if _, err := fmt.Fprintf(w, " commands=()\n"); err != nil {
- return err
- }
+func writeCommands(buf *bytes.Buffer, cmd *Command) {
+ buf.WriteString(" commands=()\n")
for _, c := range cmd.Commands() {
if !c.IsAvailableCommand() || c == cmd.helpCommand {
continue
}
- if _, err := fmt.Fprintf(w, " commands+=(%q)\n", c.Name()); err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf(" commands+=(%q)\n", c.Name()))
}
- _, err := fmt.Fprintf(w, "\n")
- return err
+ buf.WriteString("\n")
}
-func writeFlagHandler(name string, annotations map[string][]string, w io.Writer) error {
+func writeFlagHandler(buf *bytes.Buffer, name string, annotations map[string][]string) {
for key, value := range annotations {
switch key {
case BashCompFilenameExt:
- _, err := fmt.Fprintf(w, " flags_with_completion+=(%q)\n", name)
- if err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
+ var ext string
if len(value) > 0 {
- ext := "__handle_filename_extension_flag " + strings.Join(value, "|")
- _, err = fmt.Fprintf(w, " flags_completion+=(%q)\n", ext)
+ ext = "__handle_filename_extension_flag " + strings.Join(value, "|")
} else {
- ext := "_filedir"
- _, err = fmt.Fprintf(w, " flags_completion+=(%q)\n", ext)
- }
- if err != nil {
- return err
+ ext = "_filedir"
}
+ buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", ext))
case BashCompCustom:
- _, err := fmt.Fprintf(w, " flags_with_completion+=(%q)\n", name)
- if err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
if len(value) > 0 {
handlers := strings.Join(value, "; ")
- _, err = fmt.Fprintf(w, " flags_completion+=(%q)\n", handlers)
+ buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", handlers))
} else {
- _, err = fmt.Fprintf(w, " flags_completion+=(:)\n")
- }
- if err != nil {
- return err
+ buf.WriteString(" flags_completion+=(:)\n")
}
case BashCompSubdirsInDir:
- _, err := fmt.Fprintf(w, " flags_with_completion+=(%q)\n", name)
+ buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
+ var ext string
if len(value) == 1 {
- ext := "__handle_subdirs_in_dir_flag " + value[0]
- _, err = fmt.Fprintf(w, " flags_completion+=(%q)\n", ext)
+ ext = "__handle_subdirs_in_dir_flag " + value[0]
} else {
- ext := "_filedir -d"
- _, err = fmt.Fprintf(w, " flags_completion+=(%q)\n", ext)
- }
- if err != nil {
- return err
+ ext = "_filedir -d"
}
+ buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", ext))
}
}
- return nil
}
-func writeShortFlag(flag *pflag.Flag, w io.Writer) error {
- b := (len(flag.NoOptDefVal) > 0)
+func writeShortFlag(buf *bytes.Buffer, flag *pflag.Flag) {
name := flag.Shorthand
format := " "
- if !b {
+ if len(flag.NoOptDefVal) == 0 {
format += "two_word_"
}
format += "flags+=(\"-%s\")\n"
- if _, err := fmt.Fprintf(w, format, name); err != nil {
- return err
- }
- return writeFlagHandler("-"+name, flag.Annotations, w)
+ buf.WriteString(fmt.Sprintf(format, name))
+ writeFlagHandler(buf, "-"+name, flag.Annotations)
}
-func writeFlag(flag *pflag.Flag, w io.Writer) error {
- b := (len(flag.NoOptDefVal) > 0)
+func writeFlag(buf *bytes.Buffer, flag *pflag.Flag) {
name := flag.Name
format := " flags+=(\"--%s"
- if !b {
+ if len(flag.NoOptDefVal) == 0 {
format += "="
}
format += "\")\n"
- if _, err := fmt.Fprintf(w, format, name); err != nil {
- return err
- }
- return writeFlagHandler("--"+name, flag.Annotations, w)
+ buf.WriteString(fmt.Sprintf(format, name))
+ writeFlagHandler(buf, "--"+name, flag.Annotations)
}
-func writeLocalNonPersistentFlag(flag *pflag.Flag, w io.Writer) error {
- b := (len(flag.NoOptDefVal) > 0)
+func writeLocalNonPersistentFlag(buf *bytes.Buffer, flag *pflag.Flag) {
name := flag.Name
format := " local_nonpersistent_flags+=(\"--%s"
- if !b {
+ if len(flag.NoOptDefVal) == 0 {
format += "="
}
format += "\")\n"
- _, err := fmt.Fprintf(w, format, name)
- return err
+ buf.WriteString(fmt.Sprintf(format, name))
}
-func writeFlags(cmd *Command, w io.Writer) error {
- _, err := fmt.Fprintf(w, ` flags=()
+func writeFlags(buf *bytes.Buffer, cmd *Command) {
+ buf.WriteString(` flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
`)
- if err != nil {
- return err
- }
localNonPersistentFlags := cmd.LocalNonPersistentFlags()
- var visitErr error
cmd.NonInheritedFlags().VisitAll(func(flag *pflag.Flag) {
if nonCompletableFlag(flag) {
return
}
- if err := writeFlag(flag, w); err != nil {
- visitErr = err
- return
- }
+ writeFlag(buf, flag)
if len(flag.Shorthand) > 0 {
- if err := writeShortFlag(flag, w); err != nil {
- visitErr = err
- return
- }
+ writeShortFlag(buf, flag)
}
if localNonPersistentFlags.Lookup(flag.Name) != nil {
- if err := writeLocalNonPersistentFlag(flag, w); err != nil {
- visitErr = err
- return
- }
+ writeLocalNonPersistentFlag(buf, flag)
}
})
- if visitErr != nil {
- return visitErr
- }
cmd.InheritedFlags().VisitAll(func(flag *pflag.Flag) {
if nonCompletableFlag(flag) {
return
}
- if err := writeFlag(flag, w); err != nil {
- visitErr = err
- return
- }
+ writeFlag(buf, flag)
if len(flag.Shorthand) > 0 {
- if err := writeShortFlag(flag, w); err != nil {
- visitErr = err
- return
- }
+ writeShortFlag(buf, flag)
}
})
- if visitErr != nil {
- return visitErr
- }
- _, err = fmt.Fprintf(w, "\n")
- return err
+ buf.WriteString("\n")
}
-func writeRequiredFlag(cmd *Command, w io.Writer) error {
- if _, err := fmt.Fprintf(w, " must_have_one_flag=()\n"); err != nil {
- return err
- }
+func writeRequiredFlag(buf *bytes.Buffer, cmd *Command) {
+ buf.WriteString(" must_have_one_flag=()\n")
flags := cmd.NonInheritedFlags()
- var visitErr error
flags.VisitAll(func(flag *pflag.Flag) {
if nonCompletableFlag(flag) {
return
@@ -481,107 +412,68 @@ func writeRequiredFlag(cmd *Command, w io.Writer) error {
switch key {
case BashCompOneRequiredFlag:
format := " must_have_one_flag+=(\"--%s"
- b := (flag.Value.Type() == "bool")
- if !b {
+ if flag.Value.Type() != "bool" {
format += "="
}
format += "\")\n"
- if _, err := fmt.Fprintf(w, format, flag.Name); err != nil {
- visitErr = err
- return
- }
+ buf.WriteString(fmt.Sprintf(format, flag.Name))
if len(flag.Shorthand) > 0 {
- if _, err := fmt.Fprintf(w, " must_have_one_flag+=(\"-%s\")\n", flag.Shorthand); err != nil {
- visitErr = err
- return
- }
+ buf.WriteString(fmt.Sprintf(" must_have_one_flag+=(\"-%s\")\n", flag.Shorthand))
}
}
}
})
- return visitErr
}
-func writeRequiredNouns(cmd *Command, w io.Writer) error {
- if _, err := fmt.Fprintf(w, " must_have_one_noun=()\n"); err != nil {
- return err
- }
+func writeRequiredNouns(buf *bytes.Buffer, cmd *Command) {
+ buf.WriteString(" must_have_one_noun=()\n")
sort.Sort(sort.StringSlice(cmd.ValidArgs))
for _, value := range cmd.ValidArgs {
- if _, err := fmt.Fprintf(w, " must_have_one_noun+=(%q)\n", value); err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf(" must_have_one_noun+=(%q)\n", value))
}
- return nil
}
-func writeArgAliases(cmd *Command, w io.Writer) error {
- if _, err := fmt.Fprintf(w, " noun_aliases=()\n"); err != nil {
- return err
- }
+func writeArgAliases(buf *bytes.Buffer, cmd *Command) {
+ buf.WriteString(" noun_aliases=()\n")
sort.Sort(sort.StringSlice(cmd.ArgAliases))
for _, value := range cmd.ArgAliases {
- if _, err := fmt.Fprintf(w, " noun_aliases+=(%q)\n", value); err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf(" noun_aliases+=(%q)\n", value))
}
- return nil
}
-func gen(cmd *Command, w io.Writer) error {
+func gen(buf *bytes.Buffer, cmd *Command) {
for _, c := range cmd.Commands() {
if !c.IsAvailableCommand() || c == cmd.helpCommand {
continue
}
- if err := gen(c, w); err != nil {
- return err
- }
+ gen(buf, c)
}
commandName := cmd.CommandPath()
commandName = strings.Replace(commandName, " ", "_", -1)
commandName = strings.Replace(commandName, ":", "__", -1)
- if _, err := fmt.Fprintf(w, "_%s()\n{\n", commandName); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, " last_command=%q\n", commandName); err != nil {
- return err
- }
- if err := writeCommands(cmd, w); err != nil {
- return err
- }
- if err := writeFlags(cmd, w); err != nil {
- return err
- }
- if err := writeRequiredFlag(cmd, w); err != nil {
- return err
- }
- if err := writeRequiredNouns(cmd, w); err != nil {
- return err
- }
- if err := writeArgAliases(cmd, w); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, "}\n\n"); err != nil {
- return err
- }
- return nil
+ buf.WriteString(fmt.Sprintf("_%s()\n{\n", commandName))
+ buf.WriteString(fmt.Sprintf(" last_command=%q\n", commandName))
+ writeCommands(buf, cmd)
+ writeFlags(buf, cmd)
+ writeRequiredFlag(buf, cmd)
+ writeRequiredNouns(buf, cmd)
+ writeArgAliases(buf, cmd)
+ buf.WriteString("}\n\n")
}
// GenBashCompletion generates bash completion file and writes to the passed writer.
func (cmd *Command) GenBashCompletion(w io.Writer) error {
- if err := preamble(w, cmd.Name()); err != nil {
- return err
- }
+ buf := new(bytes.Buffer)
+ writePreamble(buf, cmd.Name())
if len(cmd.BashCompletionFunction) > 0 {
- if _, err := fmt.Fprintf(w, "%s\n", cmd.BashCompletionFunction); err != nil {
- return err
- }
+ buf.WriteString(cmd.BashCompletionFunction + "\n")
}
- if err := gen(cmd, w); err != nil {
- return err
- }
- return postscript(w, cmd.Name())
+ gen(buf, cmd)
+ writePostscript(buf, cmd.Name())
+
+ _, err := buf.WriteTo(w)
+ return err
}
func nonCompletableFlag(flag *pflag.Flag) bool {