glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-05 21:07:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added --description flag to cobra tool

Browse source 
With this, you can add commands including a short description.
For example:
    cobra add --description 'sends consolidated data to server' send

If --description is omitted, cobra resorts to its default behaviour.
This commit is contained in:
Giuseppe Maxia 2017-12-13 11:24:59 +01:00
parent ccaecb155a
commit f17ce42b2e
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
cobra/cmd/add.go
View file

@ -25,9 +25,10 @@ import (
func init() { func init() {
addCmd.Flags().StringVarP(&packageName, "package", "t", "", "target package name (e.g. github.com/spf13/hugo)") addCmd.Flags().StringVarP(&packageName, "package", "t", "", "target package name (e.g. github.com/spf13/hugo)")
addCmd.Flags().StringVarP(&parentName, "parent", "p", "rootCmd", "variable name of parent command for this command") addCmd.Flags().StringVarP(&parentName, "parent", "p", "rootCmd", "variable name of parent command for this command")
addCmd.Flags().StringVarP(&description, "description", "d", "A brief description of your command", "optional short description of this command")
} }
var packageName, parentName string var packageName, parentName, description string
var addCmd = &cobra.Command{ var addCmd = &cobra.Command{
Use: "add [command name]", Use: "add [command name]",
@ -134,7 +135,7 @@ import (
// {{.cmdName}}Cmd represents the {{.cmdName}} command // {{.cmdName}}Cmd represents the {{.cmdName}} command
var {{.cmdName}}Cmd = &cobra.Command{ var {{.cmdName}}Cmd = &cobra.Command{
Use: "{{.cmdName}}", Use: "{{.cmdName}}",
Short: "A brief description of your command", Short: "{{.description}}",
Long: ` + "`" + `A longer description that spans multiple lines and likely contains examples Long: ` + "`" + `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example: and usage of using your command. For example:
@ -166,6 +167,7 @@ func init() {
data["license"] = license.Header data["license"] = license.Header
data["cmdPackage"] = filepath.Base(filepath.Dir(path)) // last dir of path data["cmdPackage"] = filepath.Base(filepath.Dir(path)) // last dir of path
data["parentName"] = parentName data["parentName"] = parentName
data["description"] = description
data["cmdName"] = cmdName data["cmdName"] = cmdName
cmdScript, err := executeTemplate(template, data) cmdScript, err := executeTemplate(template, data)