2019-04-25 17:06:53 +00:00
|
|
|
package cli
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"io"
|
|
|
|
"os"
|
|
|
|
"strings"
|
|
|
|
"text/tabwriter"
|
|
|
|
"text/template"
|
2020-01-04 04:45:36 +00:00
|
|
|
"unicode/utf8"
|
2019-04-25 17:06:53 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
var helpCommand = Command{
|
|
|
|
Name: "help",
|
|
|
|
Aliases: []string{"h"},
|
|
|
|
Usage: "Shows a list of commands or help for one command",
|
|
|
|
ArgsUsage: "[command]",
|
|
|
|
Action: func(c *Context) error {
|
|
|
|
args := c.Args()
|
|
|
|
if args.Present() {
|
|
|
|
return ShowCommandHelp(c, args.First())
|
|
|
|
}
|
|
|
|
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = ShowAppHelp(c)
|
2019-04-25 17:06:53 +00:00
|
|
|
return nil
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
var helpSubcommand = Command{
|
|
|
|
Name: "help",
|
|
|
|
Aliases: []string{"h"},
|
|
|
|
Usage: "Shows a list of commands or help for one command",
|
|
|
|
ArgsUsage: "[command]",
|
|
|
|
Action: func(c *Context) error {
|
|
|
|
args := c.Args()
|
|
|
|
if args.Present() {
|
|
|
|
return ShowCommandHelp(c, args.First())
|
|
|
|
}
|
|
|
|
|
|
|
|
return ShowSubcommandHelp(c)
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
// Prints help for the App or Command
|
|
|
|
type helpPrinter func(w io.Writer, templ string, data interface{})
|
|
|
|
|
|
|
|
// Prints help for the App or Command with custom template function.
|
|
|
|
type helpPrinterCustom func(w io.Writer, templ string, data interface{}, customFunc map[string]interface{})
|
|
|
|
|
2020-01-04 04:45:36 +00:00
|
|
|
// HelpPrinter is a function that writes the help output. If not set explicitly,
|
|
|
|
// this calls HelpPrinterCustom using only the default template functions.
|
|
|
|
//
|
|
|
|
// If custom logic for printing help is required, this function can be
|
|
|
|
// overridden. If the ExtraInfo field is defined on an App, this function
|
|
|
|
// should not be modified, as HelpPrinterCustom will be used directly in order
|
|
|
|
// to capture the extra information.
|
2019-04-25 17:06:53 +00:00
|
|
|
var HelpPrinter helpPrinter = printHelp
|
|
|
|
|
2020-01-04 04:45:36 +00:00
|
|
|
// HelpPrinterCustom is a function that writes the help output. It is used as
|
|
|
|
// the default implementation of HelpPrinter, and may be called directly if
|
|
|
|
// the ExtraInfo field is set on an App.
|
2019-04-25 17:06:53 +00:00
|
|
|
var HelpPrinterCustom helpPrinterCustom = printHelpCustom
|
|
|
|
|
|
|
|
// VersionPrinter prints the version for the App
|
|
|
|
var VersionPrinter = printVersion
|
|
|
|
|
|
|
|
// ShowAppHelpAndExit - Prints the list of subcommands for the app and exits with exit code.
|
|
|
|
func ShowAppHelpAndExit(c *Context, exitCode int) {
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = ShowAppHelp(c)
|
2019-04-25 17:06:53 +00:00
|
|
|
os.Exit(exitCode)
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowAppHelp is an action that displays the help.
|
2020-01-04 04:45:36 +00:00
|
|
|
func ShowAppHelp(c *Context) error {
|
|
|
|
template := c.App.CustomAppHelpTemplate
|
|
|
|
if template == "" {
|
|
|
|
template = AppHelpTemplate
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
|
|
|
|
if c.App.ExtraInfo == nil {
|
|
|
|
HelpPrinter(c.App.Writer, template, c.App)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-04-25 17:06:53 +00:00
|
|
|
customAppData := func() map[string]interface{} {
|
|
|
|
return map[string]interface{}{
|
|
|
|
"ExtraInfo": c.App.ExtraInfo,
|
|
|
|
}
|
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
HelpPrinterCustom(c.App.Writer, template, c.App, customAppData())
|
|
|
|
|
2019-04-25 17:06:53 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// DefaultAppComplete prints the list of subcommands as the default app completion method
|
|
|
|
func DefaultAppComplete(c *Context) {
|
2020-01-04 04:45:36 +00:00
|
|
|
DefaultCompleteWithFlags(nil)(c)
|
|
|
|
}
|
|
|
|
|
|
|
|
func printCommandSuggestions(commands []Command, writer io.Writer) {
|
|
|
|
for _, command := range commands {
|
2019-04-25 17:06:53 +00:00
|
|
|
if command.Hidden {
|
|
|
|
continue
|
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
if os.Getenv("_CLI_ZSH_AUTOCOMPLETE_HACK") == "1" {
|
|
|
|
for _, name := range command.Names() {
|
|
|
|
_, _ = fmt.Fprintf(writer, "%s:%s\n", name, command.Usage)
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
for _, name := range command.Names() {
|
|
|
|
_, _ = fmt.Fprintf(writer, "%s\n", name)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func cliArgContains(flagName string) bool {
|
|
|
|
for _, name := range strings.Split(flagName, ",") {
|
|
|
|
name = strings.TrimSpace(name)
|
|
|
|
count := utf8.RuneCountInString(name)
|
|
|
|
if count > 2 {
|
|
|
|
count = 2
|
|
|
|
}
|
|
|
|
flag := fmt.Sprintf("%s%s", strings.Repeat("-", count), name)
|
|
|
|
for _, a := range os.Args {
|
|
|
|
if a == flag {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
func printFlagSuggestions(lastArg string, flags []Flag, writer io.Writer) {
|
|
|
|
cur := strings.TrimPrefix(lastArg, "-")
|
|
|
|
cur = strings.TrimPrefix(cur, "-")
|
|
|
|
for _, flag := range flags {
|
|
|
|
if bflag, ok := flag.(BoolFlag); ok && bflag.Hidden {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
for _, name := range strings.Split(flag.GetName(), ",") {
|
|
|
|
name = strings.TrimSpace(name)
|
|
|
|
// this will get total count utf8 letters in flag name
|
|
|
|
count := utf8.RuneCountInString(name)
|
|
|
|
if count > 2 {
|
|
|
|
count = 2 // resuse this count to generate single - or -- in flag completion
|
|
|
|
}
|
|
|
|
// if flag name has more than one utf8 letter and last argument in cli has -- prefix then
|
|
|
|
// skip flag completion for short flags example -v or -x
|
|
|
|
if strings.HasPrefix(lastArg, "--") && count == 1 {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// match if last argument matches this flag and it is not repeated
|
|
|
|
if strings.HasPrefix(name, cur) && cur != name && !cliArgContains(flag.GetName()) {
|
|
|
|
flagCompletion := fmt.Sprintf("%s%s", strings.Repeat("-", count), name)
|
|
|
|
_, _ = fmt.Fprintln(writer, flagCompletion)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func DefaultCompleteWithFlags(cmd *Command) func(c *Context) {
|
|
|
|
return func(c *Context) {
|
|
|
|
if len(os.Args) > 2 {
|
|
|
|
lastArg := os.Args[len(os.Args)-2]
|
|
|
|
if strings.HasPrefix(lastArg, "-") {
|
|
|
|
printFlagSuggestions(lastArg, c.App.Flags, c.App.Writer)
|
|
|
|
if cmd != nil {
|
|
|
|
printFlagSuggestions(lastArg, cmd.Flags, c.App.Writer)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if cmd != nil {
|
|
|
|
printCommandSuggestions(cmd.Subcommands, c.App.Writer)
|
|
|
|
} else {
|
|
|
|
printCommandSuggestions(c.App.Commands, c.App.Writer)
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowCommandHelpAndExit - exits with code after showing help
|
|
|
|
func ShowCommandHelpAndExit(c *Context, command string, code int) {
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = ShowCommandHelp(c, command)
|
2019-04-25 17:06:53 +00:00
|
|
|
os.Exit(code)
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowCommandHelp prints help for the given command
|
|
|
|
func ShowCommandHelp(ctx *Context, command string) error {
|
|
|
|
// show the subcommand help for a command with subcommands
|
|
|
|
if command == "" {
|
|
|
|
HelpPrinter(ctx.App.Writer, SubcommandHelpTemplate, ctx.App)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, c := range ctx.App.Commands {
|
|
|
|
if c.HasName(command) {
|
2020-01-04 04:45:36 +00:00
|
|
|
templ := c.CustomHelpTemplate
|
|
|
|
if templ == "" {
|
|
|
|
templ = CommandHelpTemplate
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
|
|
|
|
HelpPrinter(ctx.App.Writer, templ, c)
|
|
|
|
|
2019-04-25 17:06:53 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if ctx.App.CommandNotFound == nil {
|
|
|
|
return NewExitError(fmt.Sprintf("No help topic for '%v'", command), 3)
|
|
|
|
}
|
|
|
|
|
|
|
|
ctx.App.CommandNotFound(ctx, command)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowSubcommandHelp prints help for the given subcommand
|
|
|
|
func ShowSubcommandHelp(c *Context) error {
|
|
|
|
return ShowCommandHelp(c, c.Command.Name)
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowVersion prints the version number of the App
|
|
|
|
func ShowVersion(c *Context) {
|
|
|
|
VersionPrinter(c)
|
|
|
|
}
|
|
|
|
|
|
|
|
func printVersion(c *Context) {
|
2020-01-04 04:45:36 +00:00
|
|
|
_, _ = fmt.Fprintf(c.App.Writer, "%v version %v\n", c.App.Name, c.App.Version)
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// ShowCompletions prints the lists of commands within a given context
|
|
|
|
func ShowCompletions(c *Context) {
|
|
|
|
a := c.App
|
|
|
|
if a != nil && a.BashComplete != nil {
|
|
|
|
a.BashComplete(c)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// ShowCommandCompletions prints the custom completions for a given command
|
|
|
|
func ShowCommandCompletions(ctx *Context, command string) {
|
|
|
|
c := ctx.App.Command(command)
|
2020-01-04 04:45:36 +00:00
|
|
|
if c != nil {
|
|
|
|
if c.BashComplete != nil {
|
|
|
|
c.BashComplete(ctx)
|
|
|
|
} else {
|
|
|
|
DefaultCompleteWithFlags(c)(ctx)
|
|
|
|
}
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
|
2020-01-04 04:45:36 +00:00
|
|
|
// printHelpCustom is the default implementation of HelpPrinterCustom.
|
|
|
|
//
|
|
|
|
// The customFuncs map will be combined with a default template.FuncMap to
|
|
|
|
// allow using arbitrary functions in template rendering.
|
|
|
|
func printHelpCustom(out io.Writer, templ string, data interface{}, customFuncs map[string]interface{}) {
|
2019-04-25 17:06:53 +00:00
|
|
|
funcMap := template.FuncMap{
|
|
|
|
"join": strings.Join,
|
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
for key, value := range customFuncs {
|
|
|
|
funcMap[key] = value
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
w := tabwriter.NewWriter(out, 1, 8, 2, ' ', 0)
|
|
|
|
t := template.Must(template.New("help").Funcs(funcMap).Parse(templ))
|
|
|
|
err := t.Execute(w, data)
|
|
|
|
if err != nil {
|
|
|
|
// If the writer is closed, t.Execute will fail, and there's nothing
|
|
|
|
// we can do to recover.
|
|
|
|
if os.Getenv("CLI_TEMPLATE_ERROR_DEBUG") != "" {
|
2020-01-04 04:45:36 +00:00
|
|
|
_, _ = fmt.Fprintf(ErrWriter, "CLI TEMPLATE ERROR: %#v\n", err)
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = w.Flush()
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func printHelp(out io.Writer, templ string, data interface{}) {
|
2020-01-04 04:45:36 +00:00
|
|
|
HelpPrinterCustom(out, templ, data, nil)
|
2019-04-25 17:06:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func checkVersion(c *Context) bool {
|
|
|
|
found := false
|
|
|
|
if VersionFlag.GetName() != "" {
|
|
|
|
eachName(VersionFlag.GetName(), func(name string) {
|
|
|
|
if c.GlobalBool(name) || c.Bool(name) {
|
|
|
|
found = true
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return found
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkHelp(c *Context) bool {
|
|
|
|
found := false
|
|
|
|
if HelpFlag.GetName() != "" {
|
|
|
|
eachName(HelpFlag.GetName(), func(name string) {
|
|
|
|
if c.GlobalBool(name) || c.Bool(name) {
|
|
|
|
found = true
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return found
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkCommandHelp(c *Context, name string) bool {
|
|
|
|
if c.Bool("h") || c.Bool("help") {
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = ShowCommandHelp(c, name)
|
2019-04-25 17:06:53 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkSubcommandHelp(c *Context) bool {
|
|
|
|
if c.Bool("h") || c.Bool("help") {
|
2020-01-04 04:45:36 +00:00
|
|
|
_ = ShowSubcommandHelp(c)
|
2019-04-25 17:06:53 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkShellCompleteFlag(a *App, arguments []string) (bool, []string) {
|
|
|
|
if !a.EnableBashCompletion {
|
|
|
|
return false, arguments
|
|
|
|
}
|
|
|
|
|
|
|
|
pos := len(arguments) - 1
|
|
|
|
lastArg := arguments[pos]
|
|
|
|
|
|
|
|
if lastArg != "--"+BashCompletionFlag.GetName() {
|
|
|
|
return false, arguments
|
|
|
|
}
|
|
|
|
|
|
|
|
return true, arguments[:pos]
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkCompletions(c *Context) bool {
|
|
|
|
if !c.shellComplete {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
if args := c.Args(); args.Present() {
|
|
|
|
name := args.First()
|
|
|
|
if cmd := c.App.Command(name); cmd != nil {
|
|
|
|
// let the command handle the completion
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
ShowCompletions(c)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkCommandCompletions(c *Context, name string) bool {
|
|
|
|
if !c.shellComplete {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
ShowCommandCompletions(c, name)
|
|
|
|
return true
|
|
|
|
}
|