forked from cloudfoundry/cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
help.go
139 lines (112 loc) · 3.61 KB
/
help.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
package sharedaction
import (
"reflect"
"sort"
"strings"
"code.cloudfoundry.org/cli/actor/actionerror"
"code.cloudfoundry.org/cli/util/sorting"
)
// CommandInfo contains the help details of a command
type CommandInfo struct {
// Name is the command name
Name string
// Description is the command description
Description string
// Alias is the command alias
Alias string
// Usage is the command usage string, may contain examples and flavor text
Usage string
// RelatedCommands is a list of commands related to the command
RelatedCommands []string
// Flags contains the list of flags for this command
Flags []CommandFlag
// Environment is a list of environment variables specific for this command
Environment []EnvironmentVariable
}
// CommandFlag contains the help details of a command's flag
type CommandFlag struct {
// Short is the short form of the flag
Short string
// Long is the long form of the flag
Long string
// Description is the description of the flag
Description string
// Default is the flag's default value
Default string
}
// Environment contains env vars specific for this command
type EnvironmentVariable struct {
Name string
Description string
DefaultValue string
}
// CommandInfoByName returns the help information for a particular commandName in
// the commandList.
func (Actor) CommandInfoByName(commandList interface{}, commandName string) (CommandInfo, error) {
field, found := reflect.TypeOf(commandList).FieldByNameFunc(
func(fieldName string) bool {
field, _ := reflect.TypeOf(commandList).FieldByName(fieldName)
return field.Tag.Get("command") == commandName || field.Tag.Get("alias") == commandName
},
)
if !found {
return CommandInfo{}, actionerror.InvalidCommandError{CommandName: commandName}
}
tag := field.Tag
cmd := CommandInfo{
Name: tag.Get("command"),
Description: tag.Get("description"),
Alias: tag.Get("alias"),
Flags: []CommandFlag{},
Environment: []EnvironmentVariable{},
}
command := field.Type
for i := 0; i < command.NumField(); i++ {
fieldTag := command.Field(i).Tag
if fieldTag.Get("hidden") != "" {
continue
}
if fieldTag.Get("usage") != "" {
cmd.Usage = fieldTag.Get("usage")
continue
}
if fieldTag.Get("related_commands") != "" {
relatedCommands := strings.Split(fieldTag.Get("related_commands"), ", ")
sort.Slice(relatedCommands, sorting.SortAlphabeticFunc(relatedCommands))
cmd.RelatedCommands = relatedCommands
continue
}
if fieldTag.Get("description") != "" {
cmd.Flags = append(cmd.Flags, CommandFlag{
Short: fieldTag.Get("short"),
Long: fieldTag.Get("long"),
Description: fieldTag.Get("description"),
Default: fieldTag.Get("default"),
})
}
if fieldTag.Get("environmentName") != "" {
cmd.Environment = append(cmd.Environment, EnvironmentVariable{
Name: fieldTag.Get("environmentName"),
DefaultValue: fieldTag.Get("environmentDefault"),
Description: fieldTag.Get("environmentDescription"),
})
}
}
return cmd, nil
}
// CommandInfos returns a slice of CommandInfo that only fills in
// the Name and Description for all the commands in commandList
func (Actor) CommandInfos(commandList interface{}) map[string]CommandInfo {
handler := reflect.TypeOf(commandList)
infos := make(map[string]CommandInfo, handler.NumField())
for i := 0; i < handler.NumField(); i++ {
fieldTag := handler.Field(i).Tag
commandName := fieldTag.Get("command")
infos[commandName] = CommandInfo{
Name: commandName,
Description: fieldTag.Get("description"),
Alias: fieldTag.Get("alias"),
}
}
return infos
}