/
cmd.go
139 lines (122 loc) · 3.56 KB
/
cmd.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
/*
* Tencent is pleased to support the open source community by making TKEStack
* available.
*
* Copyright (C) 2012-2019 Tencent. All Rights Reserved.
*
* Licensed 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
*
* https://opensource.org/licenses/Apache-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 OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package app
import (
"fmt"
"github.com/fatih/color"
"github.com/spf13/cobra"
"os"
"runtime"
"strings"
)
// Command is a sub command structure of a cli application.
// It is recommended that a command be created with the app.NewCommand()
// function.
type Command struct {
usage string
desc string
options CliOptions
commands []*Command
runFunc RunCommandFunc
}
// CommandOption defines optional parameters for initializing the command
// structure.
type CommandOption func(*Command)
// WithCommandOptions to open the application's function to read from the
// command line.
func WithCommandOptions(opt CliOptions) CommandOption {
return func(c *Command) {
c.options = opt
}
}
// RunCommandFunc defines the application's command startup callback function.
type RunCommandFunc func(args []string) error
// WithCommandRunFunc is used to set the application's command startup callback
// function option.
func WithCommandRunFunc(run RunCommandFunc) CommandOption {
return func(c *Command) {
c.runFunc = run
}
}
// NewCommand creates a new sub command instance based on the given command name
// and other options.
func NewCommand(usage string, desc string, opts ...CommandOption) *Command {
c := &Command{
usage: usage,
desc: desc,
}
for _, o := range opts {
o(c)
}
return c
}
// AddCommand adds sub command to the current command.
func (c *Command) AddCommand(cmd *Command) {
c.commands = append(c.commands, cmd)
}
// AddCommands adds multiple sub commands to the current command.
func (c *Command) AddCommands(cmds ...*Command) {
c.commands = append(c.commands, cmds...)
}
func (c *Command) cobraCommand() *cobra.Command {
cmd := &cobra.Command{
Use: c.usage,
Short: c.desc,
}
cmd.SetOutput(os.Stdout)
cmd.Flags().SortFlags = false
if len(c.commands) > 0 {
for _, command := range c.commands {
cmd.AddCommand(command.cobraCommand())
}
}
if c.runFunc != nil {
cmd.Run = c.runCommand
}
if c.options != nil {
c.options.AddFlags(cmd.Flags())
}
addHelpCommandFlag(c.usage, cmd.Flags())
return cmd
}
func (c *Command) runCommand(cmd *cobra.Command, args []string) {
if c.runFunc != nil {
if err := c.runFunc(args); err != nil {
fmt.Printf("%v %v\n", color.RedString("Error:"), err)
os.Exit(1)
}
}
}
// AddCommand adds sub command to the application.
func (a *App) AddCommand(cmd *Command) {
a.commands = append(a.commands, cmd)
}
// AddCommands adds multiple sub commands to the application.
func (a *App) AddCommands(cmds ...*Command) {
a.commands = append(a.commands, cmds...)
}
// FormatBaseName is formatted as an executable file name under different
// operating systems according to the given name.
func FormatBaseName(basename string) string {
// Make case-insensitive and strip executable suffix if present
if runtime.GOOS == "windows" {
basename = strings.ToLower(basename)
basename = strings.TrimSuffix(basename, ".exe")
}
return basename
}