urfave-cli/help.go

249 lines
5.8 KiB
Go
Raw Normal View History

package cli
import (
"fmt"
"io"
"strings"
"text/tabwriter"
"text/template"
)
2013-07-15 00:37:43 +00:00
// The text template for the Default help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
var AppHelpTemplate = `NAME:
{{.Name}} - {{.Usage}}
USAGE:
{{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}} {{if .Flags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}
2016-03-11 16:25:30 +00:00
{{if .Version}}{{if not .HideVersion}}
VERSION:
2015-06-25 08:53:32 +00:00
{{.Version}}
2016-03-11 16:25:30 +00:00
{{end}}{{end}}{{if len .Authors}}
AUTHOR(S):
2015-06-25 08:53:32 +00:00
{{range .Authors}}{{ . }}{{end}}
{{end}}{{if .Commands}}
COMMANDS:
{{range .Commands}}{{join .Names ", "}}{{ "\t" }}{{.Usage}}
{{end}}{{end}}{{if .Flags}}
GLOBAL OPTIONS:
{{range .Flags}}{{.}}
{{end}}{{end}}{{if .Copyright }}
COPYRIGHT:
2015-06-25 08:53:32 +00:00
{{.Copyright}}
{{end}}
`
// The text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
var CommandHelpTemplate = `NAME:
2015-08-13 04:43:14 +00:00
{{.HelpName}} - {{.Usage}}
USAGE:
2015-08-13 04:43:14 +00:00
{{.HelpName}}{{if .Flags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{if .Description}}
DESCRIPTION:
2014-07-26 20:54:50 +00:00
{{.Description}}{{end}}{{if .Flags}}
OPTIONS:
{{range .Flags}}{{.}}
{{end}}{{ end }}
`
// The text template for the subcommand help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
var SubcommandHelpTemplate = `NAME:
2015-08-13 04:43:14 +00:00
{{.HelpName}} - {{.Usage}}
USAGE:
2015-08-13 04:43:14 +00:00
{{.HelpName}} command{{if .Flags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}
COMMANDS:
{{range .Commands}}{{join .Names ", "}}{{ "\t" }}{{.Usage}}
2014-07-26 20:54:50 +00:00
{{end}}{{if .Flags}}
OPTIONS:
{{range .Flags}}{{.}}
2014-07-26 20:54:50 +00:00
{{end}}{{end}}
`
2013-07-19 22:23:42 +00:00
var helpCommand = Command{
2015-08-03 23:51:11 +00:00
Name: "help",
Aliases: []string{"h"},
Usage: "Shows a list of commands or help for one command",
ArgsUsage: "[command]",
2013-07-19 22:23:42 +00:00
Action: func(c *Context) {
args := c.Args()
2013-11-24 13:40:21 +00:00
if args.Present() {
ShowCommandHelp(c, args.First())
} else {
2013-07-24 14:35:45 +00:00
ShowAppHelp(c)
}
},
}
var helpSubcommand = Command{
2015-08-03 23:51:11 +00:00
Name: "help",
Aliases: []string{"h"},
Usage: "Shows a list of commands or help for one command",
ArgsUsage: "[command]",
Action: func(c *Context) {
args := c.Args()
if args.Present() {
ShowCommandHelp(c, args.First())
} else {
ShowSubcommandHelp(c)
}
},
}
// Prints help for the App or Command
type helpPrinter func(w io.Writer, templ string, data interface{})
var HelpPrinter helpPrinter = printHelp
2014-06-18 04:37:55 +00:00
// Prints version for the App
var VersionPrinter = printVersion
2013-07-24 14:35:45 +00:00
func ShowAppHelp(c *Context) {
HelpPrinter(c.App.Writer, AppHelpTemplate, c.App)
}
2013-07-15 00:37:43 +00:00
// Prints the list of subcommands as the default app completion method
func DefaultAppComplete(c *Context) {
for _, command := range c.App.Commands {
for _, name := range command.Names() {
fmt.Fprintln(c.App.Writer, name)
}
}
}
2013-07-24 14:35:45 +00:00
// Prints help for the given command
func ShowCommandHelp(ctx *Context, command string) {
// show the subcommand help for a command with subcommands
if command == "" {
HelpPrinter(ctx.App.Writer, SubcommandHelpTemplate, ctx.App)
return
}
for _, c := range ctx.App.Commands {
2013-07-24 14:35:45 +00:00
if c.HasName(command) {
HelpPrinter(ctx.App.Writer, CommandHelpTemplate, c)
return
}
}
2013-07-15 00:37:43 +00:00
if ctx.App.CommandNotFound != nil {
ctx.App.CommandNotFound(ctx, command)
} else {
fmt.Fprintf(ctx.App.Writer, "No help topic for '%v'\n", command)
}
}
2013-07-15 00:37:43 +00:00
// Prints help for the given subcommand
func ShowSubcommandHelp(c *Context) {
ShowCommandHelp(c, c.Command.Name)
}
2013-07-24 14:35:45 +00:00
// Prints the version number of the App
func ShowVersion(c *Context) {
2014-06-18 04:37:55 +00:00
VersionPrinter(c)
}
func printVersion(c *Context) {
fmt.Fprintf(c.App.Writer, "%v version %v\n", c.App.Name, c.App.Version)
2013-07-24 14:35:45 +00:00
}
2014-04-10 17:14:13 +00:00
// 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)
2014-04-10 17:14:13 +00:00
}
}
// Prints the custom completions for a given command
func ShowCommandCompletions(ctx *Context, command string) {
c := ctx.App.Command(command)
if c != nil && c.BashComplete != nil {
c.BashComplete(ctx)
}
}
func printHelp(out io.Writer, templ string, data interface{}) {
funcMap := template.FuncMap{
"join": strings.Join,
}
w := tabwriter.NewWriter(out, 0, 8, 1, '\t', 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. We could send this to os.Stderr if we need.
return
}
w.Flush()
}
func checkVersion(c *Context) bool {
found := false
if VersionFlag.Name != "" {
eachName(VersionFlag.Name, func(name string) {
if c.GlobalBool(name) || c.Bool(name) {
found = true
}
})
2013-07-24 14:35:45 +00:00
}
return found
2013-07-24 14:35:45 +00:00
}
func checkHelp(c *Context) bool {
found := false
if HelpFlag.Name != "" {
eachName(HelpFlag.Name, func(name string) {
if c.GlobalBool(name) || c.Bool(name) {
found = true
}
})
2013-07-24 14:35:45 +00:00
}
return found
2013-07-20 15:44:09 +00:00
}
2013-08-14 04:40:39 +00:00
func checkCommandHelp(c *Context, name string) bool {
2013-08-14 04:40:39 +00:00
if c.Bool("h") || c.Bool("help") {
ShowCommandHelp(c, name)
return true
2013-08-14 04:40:39 +00:00
}
return false
2013-08-14 04:40:39 +00:00
}
2014-04-10 17:14:13 +00:00
func checkSubcommandHelp(c *Context) bool {
if c.GlobalBool("h") || c.GlobalBool("help") {
ShowSubcommandHelp(c)
return true
}
return false
}
2014-04-10 17:14:13 +00:00
func checkCompletions(c *Context) bool {
if (c.GlobalBool(BashCompletionFlag.Name) || c.Bool(BashCompletionFlag.Name)) && c.App.EnableBashCompletion {
2014-04-10 17:14:13 +00:00
ShowCompletions(c)
return true
}
return false
}
func checkCommandCompletions(c *Context, name string) bool {
if c.Bool(BashCompletionFlag.Name) && c.App.EnableBashCompletion {
2014-04-10 17:14:13 +00:00
ShowCommandCompletions(c, name)
return true
}
return false
}