Add descriptions for commands

Author: pteich

commands.go

@@ -24,9 +24,10 @@ type Command struct {
 // NewCommand creates a command that is triggered by the given name in the command line
 // all flags are defined by a struct that is parsed and filled with real values
 // this struct is then set as argument for the function that is executed if the name matches
-func NewCommand(name string, config interface{}, f CommandFunc, subCommands ...*Command) *Command {
+func NewCommand(name string, description string, config interface{}, f CommandFunc, subCommands ...*Command) *Command {
 	fs := flag.NewFlagSet(name, flag.ExitOnError)
 	fs.Usage = func() {
+		fmt.Fprint(fs.Output(), description+"\n\n")
 		if name == "" {
 			fmt.Fprintf(fs.Output(), "Usage:\n")
 		} else {
@@ -35,7 +36,7 @@ func NewCommand(name string, config interface{}, f CommandFunc, subCommands ...*
 		fs.PrintDefaults()
 
 		if len(subCommands) > 0 {
-			fmt.Fprintf(fs.Output(), "Available Subcommands: ")
+			fmt.Fprintf(fs.Output(), "\nAvailable Commands:\n")
 			for i := range subCommands {
 				fmt.Fprintf(fs.Output(), subCommands[i].fs.Name()+" ")
 			}

commands_test.go

@@ -26,15 +26,15 @@ func TestCommand_ParseAndRun(t *testing.T) {
 	var rootConfig rootCmdConfig
 	var countConfig subCmdConfig
 
-	countCmd := NewCommand("count", &countConfig, func(cmd *Command, cfg interface{}) error {
+	countCmd := NewCommand("count", "Count numbers", &countConfig, func(cmd *Command, cfg interface{}) error {
 		cfgValues := cfg.(*subCmdConfig)
 		t.Log("count command", cfgValues.Number)
 		return nil
 	})
 
-	mathCmd := NewCommand("math", nil, nil, countCmd)
+	mathCmd := NewCommand("math", "Mathematical functions", nil, nil, countCmd)
 
-	cmd := NewCommand("", &rootConfig, func(cmd *Command, cfg interface{}) error {
+	cmd := NewCommand("", "Test CLI", &rootConfig, func(cmd *Command, cfg interface{}) error {
 		cfgValues := cfg.(*rootCmdConfig)
 		t.Log("root command", cfgValues.Hostname)
 		return nil
@@ -47,7 +47,7 @@ func TestCommand_ParseAndRun(t *testing.T) {
 }
 
 func TestCommand_Dependencies(t *testing.T) {
-	c := NewCommand("testCmd", nil, nil)
+	c := NewCommand("testCmd", "Test CLI", nil, nil)
 
 	test := &testStruct{testValue: "test"}