2017-07-30 01:42:35 -07:00
|
|
|
package cobra
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"io"
|
2017-09-05 09:32:32 -07:00
|
|
|
"os"
|
2018-02-24 09:53:13 -07:00
|
|
|
"text/template"
|
|
|
|
|
|
|
|
"github.com/spf13/pflag"
|
|
|
|
)
|
|
|
|
|
|
|
|
var (
|
|
|
|
funcMap = template.FuncMap{
|
2018-02-28 03:49:53 -07:00
|
|
|
"genZshFuncName": generateZshCompletionFuncName,
|
|
|
|
"extractFlags": extractFlags,
|
|
|
|
"simpleFlag": simpleFlag,
|
2018-02-24 09:53:13 -07:00
|
|
|
}
|
|
|
|
zshCompletionText = `
|
|
|
|
{{/* for pflag.Flag (specifically annotations) */}}
|
|
|
|
{{define "flagAnnotations" -}}
|
|
|
|
{{with index .Annotations "cobra_annotation_bash_completion_filename_extensions"}}:filename:_files{{end}}
|
|
|
|
{{- end}}
|
|
|
|
|
|
|
|
{{/* for pflag.Flag with short and long options */}}
|
|
|
|
{{define "complexFlag" -}}
|
|
|
|
"(-{{.Shorthand}} --{{.Name}})"{-{{.Shorthand}},--{{.Name}}}"[{{.Usage}}]{{template "flagAnnotations" .}}"
|
|
|
|
{{- end}}
|
|
|
|
|
|
|
|
{{/* for pflag.Flag with either short or long options */}}
|
|
|
|
{{define "simpleFlag" -}}
|
|
|
|
"{{with .Name}}--{{.}}{{else}}-{{.Shorthand}}{{end}}[{{.Usage}}]{{template "flagAnnotations" .}}"
|
|
|
|
{{- end}}
|
|
|
|
|
|
|
|
{{/* should accept Command (that contains subcommands) as parameter */}}
|
|
|
|
{{define "argumentsC" -}}
|
2018-02-28 03:49:53 -07:00
|
|
|
{{ $cmdPath := genZshFuncName .}}
|
|
|
|
function {{$cmdPath}} {
|
2018-02-26 13:31:06 -07:00
|
|
|
local -a commands
|
2018-02-24 09:53:13 -07:00
|
|
|
|
2018-02-26 13:31:06 -07:00
|
|
|
_arguments -C \{{- range extractFlags .}}
|
|
|
|
{{if simpleFlag .}}{{template "simpleFlag" .}}{{else}}{{template "complexFlag" .}}{{end}} \{{- end}}
|
|
|
|
"1: :->cmnds" \
|
2018-02-24 09:53:13 -07:00
|
|
|
"*::arg:->args"
|
|
|
|
|
2018-02-26 13:31:06 -07:00
|
|
|
case $state in
|
|
|
|
cmnds)
|
|
|
|
commands=({{range .Commands}}{{if not .Hidden}}
|
2018-02-28 03:49:53 -07:00
|
|
|
"{{.Name}}:{{.Short}}"{{end}}{{end}}
|
2018-02-26 13:31:06 -07:00
|
|
|
)
|
|
|
|
_describe "command" commands
|
|
|
|
;;
|
|
|
|
esac
|
|
|
|
|
|
|
|
case "$words[1]" in {{- range .Commands}}{{if not .Hidden}}
|
2018-02-28 03:49:53 -07:00
|
|
|
{{.Name}})
|
|
|
|
{{$cmdPath}}_{{.Name}}
|
2018-02-26 13:31:06 -07:00
|
|
|
;;{{end}}{{end}}
|
|
|
|
esac
|
2018-02-24 09:53:13 -07:00
|
|
|
}
|
2018-02-26 13:31:06 -07:00
|
|
|
{{range .Commands}}{{if not .Hidden}}
|
2018-02-24 09:53:13 -07:00
|
|
|
{{template "selectCmdTemplate" .}}
|
2018-02-26 13:31:06 -07:00
|
|
|
{{- end}}{{end}}
|
2018-02-24 09:53:13 -07:00
|
|
|
{{- end}}
|
|
|
|
|
|
|
|
{{/* should accept Command without subcommands as parameter */}}
|
|
|
|
{{define "arguments" -}}
|
2018-02-28 03:49:53 -07:00
|
|
|
function {{genZshFuncName .}} {
|
2018-02-26 13:31:06 -07:00
|
|
|
{{" _arguments"}}{{range extractFlags .}} \
|
2018-02-24 09:53:13 -07:00
|
|
|
{{if simpleFlag .}}{{template "simpleFlag" .}}{{else}}{{template "complexFlag" .}}{{end -}}
|
|
|
|
{{end}}
|
|
|
|
}
|
2018-02-26 13:31:06 -07:00
|
|
|
{{end}}
|
2018-02-24 09:53:13 -07:00
|
|
|
|
2018-02-26 13:31:06 -07:00
|
|
|
{{/* dispatcher for commands with or without subcommands */}}
|
2018-02-24 09:53:13 -07:00
|
|
|
{{define "selectCmdTemplate" -}}
|
2018-02-25 05:12:58 -07:00
|
|
|
{{if .Hidden}}{{/* ignore hidden*/}}{{else -}}
|
2018-02-24 09:53:13 -07:00
|
|
|
{{if .Commands}}{{template "argumentsC" .}}{{else}}{{template "arguments" .}}{{end}}
|
|
|
|
{{- end}}
|
2018-02-25 05:12:58 -07:00
|
|
|
{{- end}}
|
2018-02-24 09:53:13 -07:00
|
|
|
|
2018-02-26 13:31:06 -07:00
|
|
|
{{/* template entry point */}}
|
2018-02-24 09:53:13 -07:00
|
|
|
{{define "Main" -}}
|
2018-02-28 03:49:53 -07:00
|
|
|
#compdef _{{.Name}} {{.Name}}
|
2018-02-24 09:53:13 -07:00
|
|
|
|
|
|
|
{{template "selectCmdTemplate" .}}
|
|
|
|
{{end}}
|
|
|
|
`
|
2017-07-30 01:42:35 -07:00
|
|
|
)
|
|
|
|
|
2017-09-05 09:32:32 -07:00
|
|
|
// GenZshCompletionFile generates zsh completion file.
|
2017-09-05 10:20:51 -07:00
|
|
|
func (c *Command) GenZshCompletionFile(filename string) error {
|
2017-09-05 09:32:32 -07:00
|
|
|
outFile, err := os.Create(filename)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer outFile.Close()
|
|
|
|
|
2017-09-05 10:20:51 -07:00
|
|
|
return c.GenZshCompletion(outFile)
|
2017-09-05 09:32:32 -07:00
|
|
|
}
|
|
|
|
|
2017-07-30 01:42:35 -07:00
|
|
|
// GenZshCompletion generates a zsh completion file and writes to the passed writer.
|
2017-09-05 10:20:51 -07:00
|
|
|
func (c *Command) GenZshCompletion(w io.Writer) error {
|
2018-02-24 09:53:13 -07:00
|
|
|
tmpl, err := template.New("Main").Funcs(funcMap).Parse(zshCompletionText)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("error creating zsh completion template: %v", err)
|
|
|
|
}
|
|
|
|
return tmpl.Execute(w, c)
|
2017-07-30 01:42:35 -07:00
|
|
|
}
|
|
|
|
|
2018-02-28 03:49:53 -07:00
|
|
|
func generateZshCompletionFuncName(c *Command) string {
|
|
|
|
if c.HasParent() {
|
|
|
|
return generateZshCompletionFuncName(c.Parent()) + "_" + c.Name()
|
2017-07-30 01:42:35 -07:00
|
|
|
}
|
2018-02-28 03:49:53 -07:00
|
|
|
return "_" + c.Name()
|
2017-07-30 01:42:35 -07:00
|
|
|
}
|
|
|
|
|
2018-02-24 09:53:13 -07:00
|
|
|
func extractFlags(c *Command) []*pflag.Flag {
|
|
|
|
var flags []*pflag.Flag
|
|
|
|
c.LocalFlags().VisitAll(func(f *pflag.Flag) {
|
2018-02-25 05:12:58 -07:00
|
|
|
if !f.Hidden {
|
|
|
|
flags = append(flags, f)
|
|
|
|
}
|
2018-02-24 09:53:13 -07:00
|
|
|
})
|
|
|
|
c.InheritedFlags().VisitAll(func(f *pflag.Flag) {
|
2018-02-25 05:12:58 -07:00
|
|
|
if !f.Hidden {
|
|
|
|
flags = append(flags, f)
|
|
|
|
}
|
2018-02-24 09:53:13 -07:00
|
|
|
})
|
|
|
|
return flags
|
2017-07-30 01:42:35 -07:00
|
|
|
}
|
|
|
|
|
2018-02-24 09:53:13 -07:00
|
|
|
func simpleFlag(p *pflag.Flag) bool {
|
|
|
|
return p.Name == "" || p.Shorthand == ""
|
2017-07-30 01:42:35 -07:00
|
|
|
}
|