-
Notifications
You must be signed in to change notification settings - Fork 67
/
group.go
130 lines (108 loc) · 3.44 KB
/
group.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
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package cmdutils
import (
"fmt"
"strings"
"unicode"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
// FlagGrouping holds a superset of all flagsets for all commands
type FlagGrouping struct {
groups map[*cobra.Command]*NamedFlagSetGroup
}
type namedFlagSet struct {
name string
fs *pflag.FlagSet
}
// NamedFlagSetGroup holds a single group of flagsets
type NamedFlagSetGroup struct {
list []namedFlagSet
}
// NewGrouping creates an instance of Grouping
func NewGrouping() *FlagGrouping {
return &FlagGrouping{
make(map[*cobra.Command]*NamedFlagSetGroup),
}
}
// New creates a new group of flagsets for use with a subcommand
func (g *FlagGrouping) New(cmd *cobra.Command) *NamedFlagSetGroup {
n := &NamedFlagSetGroup{}
g.groups[cmd] = n
return n
}
// InFlagSet returns new or existing named FlagSet in a group
func (n *NamedFlagSetGroup) InFlagSet(name string, cb func(*pflag.FlagSet)) {
for _, nfs := range n.list {
if nfs.name == name {
cb(nfs.fs)
return
}
}
nfs := namedFlagSet{
name: name,
fs: &pflag.FlagSet{},
}
cb(nfs.fs)
n.list = append(n.list, nfs)
}
// AddTo mixes all flagsets in the given group to another flagset
func (n *NamedFlagSetGroup) AddTo(cmd *cobra.Command) {
for _, nfs := range n.list {
cmd.Flags().AddFlagSet(nfs.fs)
}
}
// Usage is for use with (*cobra.Command).SetUsageFunc
func (g *FlagGrouping) Usage(cmd *cobra.Command) error {
if cmd == nil {
return fmt.Errorf("nil command")
}
group := g.groups[cmd]
usage := []string{fmt.Sprintf("Usage: %s", cmd.UseLine())}
if cmd.HasAvailableSubCommands() {
usage = append(usage, "\nCommands:")
for _, subCommand := range cmd.Commands() {
usage = append(usage, fmt.Sprintf(" %-10s %s", subCommand.Name(), subCommand.Short))
}
}
if cmd.HasExample() {
usage = append(usage, "\nExamples:")
usage = append(usage, cmd.Example)
}
if len(cmd.Aliases) > 0 {
usage = append(usage, "\nAliases: "+cmd.NameAndAliases())
}
if group != nil {
for _, nfs := range group.list {
usage = append(usage, fmt.Sprintf("\n%s flags:", nfs.name))
usage = append(usage, strings.TrimRightFunc(nfs.fs.FlagUsages(), unicode.IsSpace))
}
}
usage = append(usage, "\nCommon flags:")
if len(cmd.PersistentFlags().FlagUsages()) != 0 {
usage = append(usage, strings.TrimRightFunc(cmd.PersistentFlags().FlagUsages(), unicode.IsSpace))
}
if len(cmd.InheritedFlags().FlagUsages()) != 0 {
usage = append(usage, strings.TrimRightFunc(cmd.InheritedFlags().FlagUsages(), unicode.IsSpace))
}
usage = append(usage,
fmt.Sprintf("\nUse '%s [command] --help' for more information about a command.\n",
cmd.CommandPath()))
cmd.Println(strings.Join(usage, "\n"))
return nil
}