/
usage.go
157 lines (139 loc) · 3.25 KB
/
usage.go
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
package cli
import (
"bytes"
_ "embed"
"flag"
"sort"
"strings"
"text/tabwriter"
"text/template"
)
func Usage() error {
return flag.ErrHelp
}
//go:embed usage.gotext
var usageTemplate string
var defaultUsage = template.Must(template.New("usage").Funcs(colors).Parse(usageTemplate))
type usage struct {
cmd *subcommand
root *subcommand
}
func (u *usage) Name() string {
return u.root.name
}
func (u *usage) Usage() string {
out := new(strings.Builder)
out.WriteString(u.cmd.full)
if u.cmd.run == nil && len(u.cmd.commands) > 0 {
out.WriteString(dim())
if u.cmd.full != "" {
out.WriteString(":")
}
out.WriteString("command")
out.WriteString(reset())
}
if len(u.cmd.args) > 0 {
for i, arg := range u.cmd.args {
if i > 0 || u.cmd.full != "" {
out.WriteString(" ")
}
out.WriteString(dim())
out.WriteString("<")
out.WriteString(arg.name)
out.WriteString(">")
out.WriteString(reset())
}
}
return out.String()
}
func (u *usage) Description() string {
return u.cmd.help
}
func (u *usage) Commands() (commands usageCommands) {
for _, cmd := range u.cmd.commands {
if cmd.advanced || cmd.hidden {
continue
}
commands = append(commands, &usageCommand{cmd})
}
// Sort by name
sort.Slice(commands, func(i, j int) bool {
return commands[i].c.name < commands[j].c.name
})
return commands
}
func (u *usage) Advanced() (commands usageCommands) {
for _, cmd := range u.cmd.commands {
if !cmd.advanced || cmd.hidden {
continue
}
commands = append(commands, &usageCommand{cmd})
}
// Sort by name
sort.Slice(commands, func(i, j int) bool {
return commands[i].c.name < commands[j].c.name
})
return commands
}
func (u *usage) Flags() (flags usageFlags) {
flags = make(usageFlags, len(u.cmd.flags))
for i, flag := range u.cmd.flags {
flags[i] = &usageFlag{flag}
}
// Sort by name
sort.Slice(flags, func(i, j int) bool {
if hasShort(flags[i]) == hasShort(flags[j]) {
// Both have shorts or don't have shorts, so sort by name
return flags[i].f.name < flags[j].f.name
}
// Shorts above non-shorts
return flags[i].f.short > flags[j].f.short
})
return flags
}
type usageCommand struct {
c *subcommand
}
type usageCommands []*usageCommand
func (cmds usageCommands) Usage() (string, error) {
buf := new(bytes.Buffer)
tw := tabwriter.NewWriter(buf, 0, 0, 2, ' ', 0)
for _, cmd := range cmds {
tw.Write([]byte("\t\t" + cmd.c.full))
if cmd.c.help != "" {
tw.Write([]byte("\t" + dim() + cmd.c.help + reset()))
}
tw.Write([]byte("\n"))
}
if err := tw.Flush(); err != nil {
return "", err
}
return strings.TrimSpace(buf.String()), nil
}
type usageFlag struct {
f *Flag
}
type usageFlags []*usageFlag
func (flags usageFlags) Usage() (string, error) {
buf := new(bytes.Buffer)
tw := tabwriter.NewWriter(buf, 0, 0, 2, ' ', 0)
for _, flag := range flags {
tw.Write([]byte("\t\t"))
if flag.f.short != 0 {
tw.Write([]byte("-" + string(flag.f.short) + ", "))
}
tw.Write([]byte("--" + flag.f.name))
if flag.f.help != "" {
tw.Write([]byte("\t"))
tw.Write([]byte(dim() + flag.f.help + reset()))
}
tw.Write([]byte("\n"))
}
if err := tw.Flush(); err != nil {
return "", err
}
return strings.TrimSpace(buf.String()), nil
}
func hasShort(flag *usageFlag) bool {
return flag.f.short != 0
}