mirror of
https://github.com/spf13/cobra
synced 2024-07-04 17:25:51 +00:00
1169e1f351
This patch allows users to the value used for the help flag's shorthand character so that when there's a global "host" flag, it can use the "h" for its shorthand and the help flag can use "?". Additionally, the ability to format the help flag's usage value would also be nice for applications with different casing standards for help output. Users should simply set cobra.HelpFlagShorthand (defaults to "h") to the desired shorthand value while using cobra.HelpFlagUsageFormatString to specify a format string for the flag's usage value. The format string accept a single substitution, the command's name.
122 lines
3.7 KiB
Go
122 lines
3.7 KiB
Go
// Copyright © 2013 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// 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
|
|
// 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.
|
|
|
|
// Commands similar to git, go tools and other modern CLI tools
|
|
// inspired by go, go-Commander, gh and subcommand
|
|
|
|
package cobra
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"reflect"
|
|
"strconv"
|
|
"strings"
|
|
"text/template"
|
|
)
|
|
|
|
var initializers []func()
|
|
|
|
// automatic prefix matching can be a dangerous thing to automatically enable in CLI tools.
|
|
// Set this to true to enable it
|
|
var EnablePrefixMatching bool = false
|
|
|
|
// enables an information splash screen on Windows if the CLI is started from explorer.exe.
|
|
var EnableWindowsMouseTrap bool = true
|
|
|
|
// HelpFlagShorthand is the character used to for the help flag's shorthand notation. The
|
|
// default value is "h".
|
|
var HelpFlagShorthand string = "h"
|
|
|
|
// HelpFlagUsageFormatString is the format string used with fmt.Sprintf to produce the
|
|
// usage value for the help flag. The name of a given command is substituted in the
|
|
// formatted result.
|
|
var HelpFlagUsageFormatString string = "help for %s"
|
|
|
|
var MousetrapHelpText string = `This is a command line tool
|
|
|
|
You need to open cmd.exe and run it from there.
|
|
`
|
|
|
|
//OnInitialize takes a series of func() arguments and appends them to a slice of func().
|
|
func OnInitialize(y ...func()) {
|
|
for _, x := range y {
|
|
initializers = append(initializers, x)
|
|
}
|
|
}
|
|
|
|
//Gt takes two types and checks whether the first type is greater than the second. In case of types Arrays, Chans,
|
|
//Maps and Slices, Gt will compare their lengths. Ints are compared directly while strings are first parsed as
|
|
//ints and then compared.
|
|
func Gt(a interface{}, b interface{}) bool {
|
|
var left, right int64
|
|
av := reflect.ValueOf(a)
|
|
|
|
switch av.Kind() {
|
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
|
left = int64(av.Len())
|
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
left = av.Int()
|
|
case reflect.String:
|
|
left, _ = strconv.ParseInt(av.String(), 10, 64)
|
|
}
|
|
|
|
bv := reflect.ValueOf(b)
|
|
|
|
switch bv.Kind() {
|
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
|
right = int64(bv.Len())
|
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
right = bv.Int()
|
|
case reflect.String:
|
|
right, _ = strconv.ParseInt(bv.String(), 10, 64)
|
|
}
|
|
|
|
return left > right
|
|
}
|
|
|
|
//Eq takes two types and checks whether they are equal. Supported types are int and string. Unsupported types will panic.
|
|
func Eq(a interface{}, b interface{}) bool {
|
|
av := reflect.ValueOf(a)
|
|
bv := reflect.ValueOf(b)
|
|
|
|
switch av.Kind() {
|
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
|
panic("Eq called on unsupported type")
|
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
return av.Int() == bv.Int()
|
|
case reflect.String:
|
|
return av.String() == bv.String()
|
|
}
|
|
return false
|
|
}
|
|
|
|
//rpad adds padding to the right of a string
|
|
func rpad(s string, padding int) string {
|
|
template := fmt.Sprintf("%%-%ds", padding)
|
|
return fmt.Sprintf(template, s)
|
|
}
|
|
|
|
// tmpl executes the given template text on data, writing the result to w.
|
|
func tmpl(w io.Writer, text string, data interface{}) error {
|
|
t := template.New("top")
|
|
t.Funcs(template.FuncMap{
|
|
"trim": strings.TrimSpace,
|
|
"rpad": rpad,
|
|
"gt": Gt,
|
|
"eq": Eq,
|
|
})
|
|
template.Must(t.Parse(text))
|
|
return t.Execute(w, data)
|
|
}
|