init

Author: cppforlife

Gopkg.lock

@@ -0,0 +1,38 @@
+# Gopkg.toml example
+#
+# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/spf13/cobra"
+  version = "0.0.3"
+
+[[constraint]]
+  name = "github.com/spf13/pflag"
+  version = "1.0.2"
+
+[prune]
+  go-tests = true
+  unused-packages = true

Gopkg.toml

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Dmitriy Kalinin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -0,0 +1,3 @@
+# cobrautil
+
+util package to help with https://github.com/spf13/cobra.

README.md

@@ -0,0 +1,57 @@
+package cobrautil
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	cobra.AddTemplateFunc("commandsWithAnnotation", func(cmd *cobra.Command, key, value string) []*cobra.Command {
+		var result []*cobra.Command
+		for _, c := range cmd.Commands() {
+			anns := map[string]string{}
+			if c.Annotations != nil {
+				anns = c.Annotations
+			}
+			if anns[key] == value {
+				result = append(result, c)
+			}
+		}
+		return result
+	})
+}
+
+type HelpSection struct {
+	Key   string
+	Value string
+	Title string
+}
+
+func HelpSectionsUsageTemplate(sections []HelpSection) string {
+	unmodifiedCmd := &cobra.Command{}
+	usageTemplate := unmodifiedCmd.UsageTemplate()
+
+	const defaultTpl = `{{if .HasAvailableSubCommands}}
+
+Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
+  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}`
+
+	if !strings.Contains(usageTemplate, defaultTpl) {
+		panic("Expected to find available commands section in spf13/cobra default usage template")
+	}
+
+	newTpl := "{{if .HasAvailableSubCommands}}"
+
+	for _, section := range sections {
+		newTpl += fmt.Sprintf(`{{$cmds := (commandsWithAnnotation . "%s" "%s")}}{{if $cmds}}
+
+%s{{range $cmds}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
+  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}`, section.Key, section.Value, section.Title)
+	}
+
+	newTpl += "{{end}}"
+
+	return strings.Replace(usageTemplate, defaultTpl, newTpl, 1)
+}

help_sections.go

@@ -0,0 +1,86 @@
+package cobrautil
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+func VisitCommands(cmd *cobra.Command, f func(*cobra.Command)) {
+	f(cmd)
+	for _, child := range cmd.Commands() {
+		VisitCommands(child, f)
+	}
+}
+
+func WrapRunEForCmd(additionalRunE func(*cobra.Command, []string) error) func(cmd *cobra.Command) {
+	return func(cmd *cobra.Command) {
+		origRunE := cmd.RunE
+		cmd.RunE = func(cmd2 *cobra.Command, args []string) error {
+			err := additionalRunE(cmd2, args)
+			if err != nil {
+				return err
+			}
+			return origRunE(cmd2, args)
+		}
+	}
+}
+
+func ReconfigureCmdWithSubcmd(cmd *cobra.Command) {
+	if len(cmd.Commands()) == 0 {
+		return
+	}
+
+	if cmd.Args == nil {
+		cmd.Args = cobra.ArbitraryArgs
+	}
+	if cmd.RunE == nil {
+		cmd.RunE = ShowSubcommands
+	}
+
+	var strs []string
+	for _, subcmd := range cmd.Commands() {
+		if !subcmd.Hidden {
+			strs = append(strs, subcmd.Use)
+		}
+	}
+
+	cmd.Short += " (" + strings.Join(strs, ", ") + ")"
+}
+
+func ReconfigureLeafCmd(cmd *cobra.Command) {
+	if len(cmd.Commands()) > 0 {
+		return
+	}
+
+	if cmd.RunE == nil {
+		panic(fmt.Sprintf("Internal: Command '%s' does not set RunE", cmd.CommandPath()))
+	}
+
+	if cmd.Args == nil {
+		origRunE := cmd.RunE
+		cmd.RunE = func(cmd2 *cobra.Command, args []string) error {
+			if len(args) > 0 {
+				return fmt.Errorf("command '%s' does not accept extra arguments '%s'", args[0], cmd2.CommandPath())
+			}
+			return origRunE(cmd2, args)
+		}
+		cmd.Args = cobra.ArbitraryArgs
+	}
+}
+
+func ShowSubcommands(cmd *cobra.Command, args []string) error {
+	var strs []string
+	for _, subcmd := range cmd.Commands() {
+		if !subcmd.Hidden {
+			strs = append(strs, subcmd.Use)
+		}
+	}
+	return fmt.Errorf("Use one of available subcommands: %s", strings.Join(strs, ", "))
+}
+
+func ShowHelp(cmd *cobra.Command, args []string) error {
+	cmd.Help()
+	return fmt.Errorf("Invalid command - see available commands/subcommands above")
+}

misc.go

@@ -0,0 +1,26 @@
+package cobrautil
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+)
+
+type ResolvableFlag interface {
+	Resolve() error
+}
+
+func ResolveFlagsForCmd(cmd *cobra.Command, args []string) error {
+	var lastFlagErr error
+	cmd.Flags().VisitAll(func(flag *pflag.Flag) {
+		if flag.Value == nil {
+			return
+		}
+		if resolvableVal, ok := flag.Value.(ResolvableFlag); ok {
+			err := resolvableVal.Resolve()
+			if err != nil {
+				lastFlagErr = err
+			}
+		}
+	})
+	return lastFlagErr
+}