|
|
|
@ -1,10 +1,36 @@
|
|
|
|
|
package cli
|
|
|
|
|
|
|
|
|
|
var helpNameTemplate = `{{$v := offset .HelpName 6}}{{wrap .HelpName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}`
|
|
|
|
|
var usageTemplate = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}}{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}`
|
|
|
|
|
var descriptionTemplate = `{{wrap .Description 3}}`
|
|
|
|
|
var authorsTemplate = `{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
|
|
|
|
|
{{range $index, $author := .Authors}}{{if $index}}
|
|
|
|
|
{{end}}{{$author}}{{end}}`
|
|
|
|
|
var visibleCommandTemplate = `{{ $cv := offsetCommands .VisibleCommands 5}}{{range .VisibleCommands}}
|
|
|
|
|
{{$s := join .Names ", "}}{{$s}}{{ $sp := subtract $cv (offset $s 3) }}{{ indent $sp ""}}{{wrap .Usage $cv}}{{end}}`
|
|
|
|
|
var visibleCommandCategoryTemplate = `{{range .VisibleCategories}}{{if .Name}}
|
|
|
|
|
{{.Name}}:{{range .VisibleCommands}}
|
|
|
|
|
{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{template "visibleCommandTemplate" .}}{{end}}{{end}}`
|
|
|
|
|
var visibleFlagCategoryTemplate = `{{range .VisibleFlagCategories}}
|
|
|
|
|
{{if .Name}}{{.Name}}
|
|
|
|
|
{{end}}{{range .Flags}}{{.}}
|
|
|
|
|
{{end}}{{end}}`
|
|
|
|
|
|
|
|
|
|
var visibleFlagTemplate = `{{range $index, $option := .VisibleFlags}}{{if $index}}{{end}}
|
|
|
|
|
{{wrap $option.String 6}}{{end}}`
|
|
|
|
|
|
|
|
|
|
var versionTemplate = `{{if .Version}}{{if not .HideVersion}}
|
|
|
|
|
|
|
|
|
|
VERSION:
|
|
|
|
|
{{.Version}}{{end}}{{end}}`
|
|
|
|
|
|
|
|
|
|
var copyrightTemplate = `{{wrap .Copyright 3}}`
|
|
|
|
|
|
|
|
|
|
// AppHelpTemplate is 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:
|
|
|
|
|
{{$v := offset .Name 6}}{{wrap .Name 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}
|
|
|
|
|
{{template "helpNameTemplate" .}}
|
|
|
|
|
|
|
|
|
|
USAGE:
|
|
|
|
|
{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}
|
|
|
|
@ -13,75 +39,56 @@ VERSION:
|
|
|
|
|
{{.Version}}{{end}}{{end}}{{if .Description}}
|
|
|
|
|
|
|
|
|
|
DESCRIPTION:
|
|
|
|
|
{{wrap .Description 3}}{{end}}{{if len .Authors}}
|
|
|
|
|
{{template "descriptionTemplate" .}}{{end}}{{if len .Authors}}
|
|
|
|
|
|
|
|
|
|
AUTHOR{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
|
|
|
|
|
{{range $index, $author := .Authors}}{{if $index}}
|
|
|
|
|
{{end}}{{$author}}{{end}}{{end}}{{if .VisibleCommands}}
|
|
|
|
|
AUTHOR{{template "authorsTemplate" .}}{{end}}{{if .VisibleCommands}}
|
|
|
|
|
|
|
|
|
|
COMMANDS:{{range .VisibleCategories}}{{if .Name}}
|
|
|
|
|
{{.Name}}:{{range .VisibleCommands}}
|
|
|
|
|
{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{ $cv := offsetCommands .VisibleCommands 5}}{{range .VisibleCommands}}
|
|
|
|
|
{{$s := join .Names ", "}}{{$s}}{{ $sp := subtract $cv (offset $s 3) }}{{ indent $sp ""}}{{wrap .Usage $cv}}{{end}}{{end}}{{end}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
|
|
|
|
|
GLOBAL OPTIONS:{{range .VisibleFlagCategories}}
|
|
|
|
|
{{if .Name}}{{.Name}}
|
|
|
|
|
{{end}}{{range .Flags}}{{.}}
|
|
|
|
|
{{end}}{{end}}{{else}}{{if .VisibleFlags}}
|
|
|
|
|
GLOBAL OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}
|
|
|
|
|
|
|
|
|
|
GLOBAL OPTIONS:
|
|
|
|
|
{{range $index, $option := .VisibleFlags}}{{if $index}}
|
|
|
|
|
{{end}}{{wrap $option.String 6}}{{end}}{{end}}{{end}}{{if .Copyright}}
|
|
|
|
|
GLOBAL OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}{{if .Copyright}}
|
|
|
|
|
|
|
|
|
|
COPYRIGHT:
|
|
|
|
|
{{wrap .Copyright 3}}{{end}}
|
|
|
|
|
{{template "copyrightTemplate" .}}{{end}}
|
|
|
|
|
`
|
|
|
|
|
|
|
|
|
|
// CommandHelpTemplate is 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:
|
|
|
|
|
{{$v := offset .HelpName 6}}{{wrap .HelpName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}
|
|
|
|
|
{{template "helpNameTemplate" .}}
|
|
|
|
|
|
|
|
|
|
USAGE:
|
|
|
|
|
{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}}{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Category}}
|
|
|
|
|
{{template "usageTemplate" .}}{{if .Category}}
|
|
|
|
|
|
|
|
|
|
CATEGORY:
|
|
|
|
|
{{.Category}}{{end}}{{if .Description}}
|
|
|
|
|
|
|
|
|
|
DESCRIPTION:
|
|
|
|
|
{{wrap .Description 3}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
{{template "descriptionTemplate" .}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
|
|
|
|
|
OPTIONS:{{range .VisibleFlagCategories}}
|
|
|
|
|
{{if .Name}}{{.Name}}
|
|
|
|
|
{{end}}{{range .Flags}}{{.}}
|
|
|
|
|
{{end}}{{end}}{{else}}{{if .VisibleFlags}}
|
|
|
|
|
OPTIONS:{{range $index, $option := .VisibleFlags}}{{if $index}}{{end}}
|
|
|
|
|
{{wrap $option.String 6}}{{end}}{{end}}{{end}}
|
|
|
|
|
`
|
|
|
|
|
OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}
|
|
|
|
|
|
|
|
|
|
OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}`
|
|
|
|
|
|
|
|
|
|
// SubcommandHelpTemplate is 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:
|
|
|
|
|
{{.HelpName}} - {{.Usage}}
|
|
|
|
|
{{template "helpNameTemplate" .}}
|
|
|
|
|
|
|
|
|
|
USAGE:
|
|
|
|
|
{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} command{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}}
|
|
|
|
|
|
|
|
|
|
DESCRIPTION:
|
|
|
|
|
{{wrap .Description 3}}{{end}}{{if .VisibleCommands}}
|
|
|
|
|
{{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}}
|
|
|
|
|
|
|
|
|
|
COMMANDS:{{ $cv := offsetCommands .VisibleCommands 5}}{{range .VisibleCommands}}
|
|
|
|
|
{{$s := join .Names ", "}}{{$s}}{{ $sp := subtract $cv (offset $s 3) }}{{ indent $sp ""}}{{wrap .Usage $cv}}{{end}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
COMMANDS:{{template "visibleCommandTemplate" .}}{{end}}{{if .VisibleFlagCategories}}
|
|
|
|
|
|
|
|
|
|
OPTIONS:{{range .VisibleFlagCategories}}
|
|
|
|
|
{{if .Name}}{{.Name}}{{end}}{{range .Flags}}{{.}}
|
|
|
|
|
{{end}}{{end}}{{else}}{{if .VisibleFlags}}
|
|
|
|
|
OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}
|
|
|
|
|
|
|
|
|
|
OPTIONS:{{range $index, $option := .VisibleFlags}}{{if $index}}{{end}}
|
|
|
|
|
{{wrap $option.String 6}}{{end}}{{end}}{{end}}
|
|
|
|
|
`
|
|
|
|
|
OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}`
|
|
|
|
|
|
|
|
|
|
var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionNum }}
|
|
|
|
|
|
|
|
|
|