Merge pull request #1795 from lizardruss/master

feat: add run commands to help usage

Author: FabianKramm

cmd/root.go

@@ -164,6 +164,47 @@ func BuildRoot(f factory.Factory, excludePlugins bool) *cobra.Command {
 	persistentFlags := rootCmd.PersistentFlags()
 	globalFlags = flags.SetGlobalFlags(persistentFlags)
 
+	rootCmd.SetUsageTemplate(`Usage:{{if .Runnable}}
+  {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}
+  {{.CommandPath}} [command]{{end}}{{if gt (len .Aliases) 0}}
+  
+Aliases:
+  {{.NameAndAliases}}{{end}}{{if .HasExample}}
+  
+Examples:
+{{.Example}}{{end}}{{if .HasAvailableSubCommands}}
+  
+Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
+  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}
+  
+Flags:
+{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
+  
+Global Flags:
+{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
+
+Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
+  {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
+
+{{- if not (eq .Name "run")}}
+
+Use "{{.CommandPath}} [command] --help" for more information about a command.
+{{- end -}}
+
+{{- if (and .HasAvailableSubCommands) -}}
+{{- range .Commands -}}
+{{- if (and .HasSubCommands (eq .Name "run"))}}
+
+Additional run commands:
+{{- range .Commands}}
+  {{rpad (printf "'%s'" .CommandPath) .CommandPathPadding}} {{.Short}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+{{end}}
+`)
+
 	// Add sub commands
 	rootCmd.AddCommand(add.NewAddCmd(f, globalFlags, plugins))
 	rootCmd.AddCommand(cleanup.NewCleanupCmd(f, globalFlags, plugins))

cmd/run.go

@@ -2,18 +2,21 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/loft-sh/devspace/pkg/devspace/hook"
 	"io"
 	"os"
 	"strings"
 
+	"github.com/loft-sh/devspace/pkg/devspace/hook"
+
 	"github.com/loft-sh/devspace/pkg/devspace/config/loader"
+	"github.com/loft-sh/devspace/pkg/devspace/config/versions/latest"
 	"github.com/loft-sh/devspace/pkg/devspace/plugin"
 
 	"github.com/loft-sh/devspace/cmd/flags"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency"
 	"github.com/loft-sh/devspace/pkg/util/factory"
 	flagspkg "github.com/loft-sh/devspace/pkg/util/flags"
+	"github.com/loft-sh/devspace/pkg/util/log"
 	"github.com/loft-sh/devspace/pkg/util/message"
 	"github.com/sirupsen/logrus"
 
@@ -93,6 +96,30 @@ devspace --dependency my-dependency run any-command --any-command-flag
 		},
 	}
 
+	logger := f.GetLog()
+	commands, _ := getCommands(f, logger)
+	for _, command := range commands {
+		description := command.Description
+		if description == "" {
+			description = "Runs command: " + command.Command
+		}
+		if len(description) > 64 {
+			if len(description) > 64 {
+				description = description[:61] + "..."
+			}
+		}
+		runCmd.AddCommand(&cobra.Command{
+			Use:                command.Name,
+			Short:              description,
+			Long:               description,
+			Args:               cobra.ArbitraryArgs,
+			DisableFlagParsing: true,
+			RunE: func(cobraCmd *cobra.Command, args []string) error {
+				return cobraCmd.Parent().RunE(cobraCmd, args)
+			},
+		})
+	}
+
 	runCmd.Flags().StringVar(&cmd.Dependency, "dependency", "", "Run a command from a specific dependency")
 	return runCmd
 }
@@ -164,3 +191,22 @@ func (cmd *RunCmd) RunRun(f factory.Factory, args []string) error {
 	// Execute command
 	return dependency.ExecuteCommand(commands, args[0], args[1:], cmd.Stdout, cmd.Stderr)
 }
+
+func getCommands(f factory.Factory, logger log.Logger) ([]*latest.CommandConfig, error) {
+	// Set config root
+	configLoader := f.NewConfigLoader("")
+	configExists, err := configLoader.SetDevSpaceRoot(logger)
+	if err != nil {
+		return nil, err
+	}
+	if !configExists {
+		return nil, errors.New(message.ConfigNotFound)
+	}
+
+	// Parse commands
+	commandsInterface, err := configLoader.LoadWithParser(loader.NewCommandsParser(), nil, logger)
+	if err != nil {
+		return nil, err
+	}
+	return commandsInterface.Config().Commands, nil
+}