Repository navigation
Expand file tree
/
Copy pathhelp_template.go
More file actions
138 lines (108 loc) · 4.09 KB
/
Copy pathhelp_template.go
File metadata and controls
138 lines (108 loc) · 4.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
//go:build !urfave_cli_no_template
package cli
import (
"io"
"strings"
"text/tabwriter"
"text/template"
)
// templatesSupported is true unless built with the urfave_cli_no_template tag.
const templatesSupported = true
// RootCommandHelpTemplate 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 RootCommandHelpTemplate = rootCommandHelpTemplate
// 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 = commandHelpTemplate
// 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 = subcommandHelpTemplate
// FishCompletionTemplate is the text template for fish shell completion.
var FishCompletionTemplate = fishCompletionTemplate
// DefaultPrintHelpCustom 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 DefaultPrintHelpCustom(out io.Writer, templ string, data any, customFuncs map[string]any) {
const maxLineLength = 10000
tracef("building default funcMap")
funcMap := template.FuncMap{
"join": strings.Join,
"subtract": subtract,
"indent": indent,
"nindent": nindent,
"trim": strings.TrimSpace,
"wrap": func(input string, offset int) string { return wrap(input, offset, maxLineLength) },
"offset": offset,
"offsetCommands": offsetCommands,
}
if wa, ok := customFuncs["wrapAt"]; ok {
if wrapAtFunc, ok := wa.(func() int); ok {
wrapAt := wrapAtFunc()
customFuncs["wrap"] = func(input string, offset int) string {
return wrap(input, offset, wrapAt)
}
}
}
for key, value := range customFuncs {
funcMap[key] = value
}
w := tabwriter.NewWriter(out, 1, 8, 2, ' ', 0)
t := template.Must(template.New("help").Funcs(funcMap).Parse(templ))
if _, err := t.New("helpNameTemplate").Parse(helpNameTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("argsTemplate").Parse(argsTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("usageTemplate").Parse(usageTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("descriptionTemplate").Parse(descriptionTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visibleCommandTemplate").Parse(visibleCommandTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("copyrightTemplate").Parse(copyrightTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("versionTemplate").Parse(versionTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visibleFlagCategoryTemplate").Parse(visibleFlagCategoryTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visibleFlagTemplate").Parse(visibleFlagTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visiblePersistentFlagTemplate").Parse(visiblePersistentFlagTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visibleGlobalFlagCategoryTemplate").Parse(strings.ReplaceAll(visibleFlagCategoryTemplate, "OPTIONS", "GLOBAL OPTIONS")); err != nil {
handleTemplateError(err)
}
if _, err := t.New("authorsTemplate").Parse(authorsTemplate); err != nil {
handleTemplateError(err)
}
if _, err := t.New("visibleCommandCategoryTemplate").Parse(visibleCommandCategoryTemplate); err != nil {
handleTemplateError(err)
}
tracef("executing template")
handleTemplateError(t.Execute(w, data))
_ = w.Flush()
}
func checkNoCustomTemplates(*Command) error {
return nil
}
func renderFishCompletion(w io.Writer, data *fishCommandCompletionTemplate) error {
const name = "cli"
t, err := template.New(name).Parse(FishCompletionTemplate)
if err != nil {
return err
}
return t.ExecuteTemplate(w, name, data)
}