cobra/cobra.go

113 lines
3.0 KiB
Go
Raw Normal View History

2013-09-03 22:54:51 +00:00
// 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"
2013-09-03 22:54:51 +00:00
"strings"
2013-09-12 14:32:51 +00:00
"text/template"
"unicode"
2013-09-03 22:54:51 +00:00
)
var templateFuncs = template.FuncMap{
"trimTrailingWhitespaces": trimTrailingWhitespaces,
"rpad": rpad,
}
var initializers []func()
// EnablePrefixMatching allows to set automatic prefix matching. Automatic prefix matching can be a dangerous thing
// to automatically enable in CLI tools.
2016-08-30 17:14:27 +00:00
// Set this to true to enable it.
var EnablePrefixMatching = false
2014-10-07 20:15:19 +00:00
2016-08-30 17:14:27 +00:00
// EnableCommandSorting controls sorting of the slice of commands, which is turned on by default.
// To disable sorting, set it to false.
var EnableCommandSorting = true
2016-08-30 17:14:27 +00:00
// AddTemplateFunc adds a template function that's available to Usage and Help
// template generation.
func AddTemplateFunc(name string, tmplFunc interface{}) {
templateFuncs[name] = tmplFunc
}
2017-04-17 17:03:07 +00:00
// AddTemplateFuncs adds multiple template functions that are available to Usage and
2016-08-30 17:14:27 +00:00
// Help template generation.
func AddTemplateFuncs(tmplFuncs template.FuncMap) {
for k, v := range tmplFuncs {
templateFuncs[k] = v
}
}
2016-08-30 17:14:27 +00:00
// OnInitialize takes a series of func() arguments and appends them to a slice of func().
func OnInitialize(y ...func()) {
2016-08-30 16:58:52 +00:00
initializers = append(initializers, y...)
}
func trimTrailingWhitespaces(s string) string {
return strings.TrimRightFunc(s, unicode.IsSpace)
}
2016-08-30 17:14:27 +00:00
// 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)
}
2013-09-12 14:32:51 +00:00
// 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").Funcs(templateFuncs)
return template.Must(t.Parse(text)).Execute(w, data)
2013-09-12 14:32:51 +00:00
}
2016-08-30 17:14:27 +00:00
// ld compares two strings and returns the levenshtein distance between them.
func ld(s, t string, ignoreCase bool) int {
if ignoreCase {
s = strings.ToLower(s)
t = strings.ToLower(t)
}
d := make([][]int, len(s)+1)
for i := range d {
d[i] = make([]int, len(t)+1)
}
for i := range d {
d[i][0] = i
}
for j := range d[0] {
d[0][j] = j
}
for j := 1; j <= len(t); j++ {
for i := 1; i <= len(s); i++ {
if s[i-1] == t[j-1] {
d[i][j] = d[i-1][j-1]
} else {
min := d[i-1][j]
if d[i][j-1] < min {
min = d[i][j-1]
}
if d[i-1][j-1] < min {
min = d[i-1][j-1]
}
d[i][j] = min + 1
}
}
}
return d[len(s)][len(t)]
}