help: configure help cmd similar to the other commands

Part of #1136

Author: elhimov

cli/cmd/help.go

@@ -2,82 +2,52 @@ package cmd
 
 import (
 	"fmt"
-	"os"
 	"strings"
 
-	"github.com/apex/log"
 	"github.com/spf13/cobra"
 	"github.com/tarantool/tt/cli/cmdcontext"
 	"github.com/tarantool/tt/cli/modules"
 	"github.com/tarantool/tt/cli/util"
 )
 
-// DefaultHelpFunc is a type of the standard built-in
-// cobra implementation of the help function.
-type DefaultHelpFunc func(*cobra.Command, []string)
-
-// configureHelpCommand configures our own help module
-// so that it can be external as well.
-// If the help is called for an external module
-// (for example `tt help version`), we try to get the help from it.
-func configureHelpCommand(cmdCtx *cmdcontext.CmdCtx, rootCmd *cobra.Command) error {
+func configureHelpCommand(rootCmd *cobra.Command, modulesInfo *modules.ModulesInfo) error {
 	// Add information about external modules into help template.
-	rootCmd.SetUsageTemplate(fmt.Sprintf(usageTemplate, getExternalCommandsString(&modulesInfo)))
-	defaultHelp := rootCmd.HelpFunc()
-
-	rootCmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {
-		cmdCtx.CommandName = cmd.Name()
-		if len(os.Args) == 1 || util.Find(args, "-h") != -1 || util.Find(args, "--help") != -1 {
-			defaultHelp(cmd, nil)
-			return
+	rootCmd.SetUsageTemplate(fmt.Sprintf(usageTemplate, getExternalCommandsString(modulesInfo)))
+
+	internalHelpModule := func(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+		fmt.Printf("internalHelpModule: cmdCtx.CommandName=%s\n", cmdCtx.CommandName)
+		fmt.Printf("internalHelpModule: args: %v\n", args)
+		if len(args) == 0 {
+			rootCmd.Help()
+			return nil
 		}
 
-		args = modules.GetDefaultCmdArgs("help")
-		err := modules.RunCmd(cmdCtx, "tt help", &modulesInfo,
-			getInternalHelpFunc(cmd, defaultHelp), args)
+		cmd, _, err := rootCmd.Find(args)
+		fmt.Printf("internalHelpModule: cmd.Name=%s\n", cmd.Name())
+		fmt.Printf("internalHelpModule: cmd.CommandPath=%s\n", cmd.CommandPath())
 		if err != nil {
-			log.Fatalf(err.Error())
+			return err
 		}
-	})
+
+		cmd.Help()
+		return nil
+	}
+
+	helpCmd := &cobra.Command{
+		Use:   "help [command]",
+		Short: "Help about any command",
+		Run:   RunModuleFunc(internalHelpModule),
+	}
 
 	// Add valid arguments for completion.
-	helpCmd := util.GetHelpCommand(rootCmd)
-	for name := range modulesInfo {
+	for name := range *modulesInfo {
 		helpCmd.ValidArgs = append(helpCmd.ValidArgs, name)
 	}
 
+	rootCmd.SetHelpCommand(helpCmd)
 	return nil
 }
 
-// getInternalHelpFunc returns a internal implementation of help module.
-func getInternalHelpFunc(cmd *cobra.Command, help DefaultHelpFunc) modules.InternalFunc {
-	return func(cmdCtx *cmdcontext.CmdCtx, args []string) error {
-		switch manifest, found := modulesInfo[cmd.CommandPath()]; {
-		// Cases when we have to run the "default" help:
-		// - `tt help` and no external help module.
-		// 	It looks strange: if we type the command `tt help`,
-		// 	the call to cmd.Name() returns `tt` and I don’t know
-		// 	what is the reason. If there is an external help module,
-		// 	then we also cannot be here (see the code below) and it
-		// 	is enough to check cmd.Name() == "tt".
-		// - `tt help -I`
-		// - `tt --help`, `tt -h` or `tt` (look code above).
-		case cmd.Name() == "tt", !found:
-			help(cmd, nil)
-		// We make a call to the external module (if it exists) with the `--help` flag.
-		default:
-			helpMsg, err := modules.GetExternalModuleHelp(manifest.Main)
-			if err != nil {
-				return err
-			}
-
-			cmd.Print(helpMsg)
-		}
-
-		return nil
-	}
-}
-
 // getExternalCommandString returns a pretty string
 // of descriptions for external modules.
 func getExternalCommandsString(modulesInfo *modules.ModulesInfo) string {

cli/cmd/root.go

@@ -318,7 +318,7 @@ func InitRoot() {
 	}
 
 	// Configure help command.
-	err = configureHelpCommand(&cmdCtx, rootCmd)
+	err = configureHelpCommand(rootCmd, &modulesInfo)
 	if err != nil {
 		log.Fatalf("Failed to set up help command: %s", err)
 	}