-
Notifications
You must be signed in to change notification settings - Fork 5
/
flag_advice.go
79 lines (66 loc) · 1.95 KB
/
flag_advice.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
package dcli
import (
"strings"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
type FlagAdvice struct {
HasPagination bool
// Map of FieldName -> FlagName
CustomFlagOverrides map[string]string
CustomFieldParsers map[string]CustomFieldParserFn
// Tx sender value
IsTx bool
TxSenderFieldName string
FromValue string
}
type FlagDesc struct {
RequiredFlags []*pflag.FlagSet
OptionalFlags []*pflag.FlagSet
}
type FieldReadLocation = bool
const (
UsedArg FieldReadLocation = true
UsedFlag FieldReadLocation = false
)
// CustomFieldParser function.
type CustomFieldParserFn = func(arg string, flags *pflag.FlagSet) (valueToSet any, usedArg FieldReadLocation, err error)
func (f FlagAdvice) Sanitize() FlagAdvice {
// map CustomFlagOverrides & CustomFieldParser keys to lower-case
// initialize if uninitialized
newFlagOverrides := make(map[string]string, len(f.CustomFlagOverrides))
for k, v := range f.CustomFlagOverrides {
newFlagOverrides[strings.ToLower(k)] = v
}
f.CustomFlagOverrides = newFlagOverrides
newFlagParsers := make(map[string]CustomFieldParserFn, len(f.CustomFieldParsers))
for k, v := range f.CustomFieldParsers {
newFlagParsers[strings.ToLower(k)] = v
}
f.CustomFieldParsers = newFlagParsers
return f
}
func FlagOnlyParser[v any](f func(fs *pflag.FlagSet) (v, error)) CustomFieldParserFn {
return func(_arg string, fs *pflag.FlagSet) (any, FieldReadLocation, error) {
t, err := f(fs)
return t, UsedFlag, err
}
}
// AddFlags from desc to cmd.
// Required flags are marked as required.
func AddFlags(cmd *cobra.Command, desc FlagDesc) {
for i := 0; i < len(desc.OptionalFlags); i++ {
cmd.Flags().AddFlagSet(desc.OptionalFlags[i])
}
for i := 0; i < len(desc.RequiredFlags); i++ {
fs := desc.RequiredFlags[i]
cmd.Flags().AddFlagSet(fs)
// mark all these flags as required.
fs.VisitAll(func(flag *pflag.Flag) {
err := cmd.MarkFlagRequired(flag.Name)
if err != nil {
panic(err)
}
})
}
}