Expand help topic functionality

samcoe · samcoe · commit 21449213e52b · 2020-09-14T17:50:50.000+02:00
diff --git a/pkg/cmd/root/help.go b/pkg/cmd/root/help.go
@@ -78,11 +78,6 @@ func rootHelpFunc(command *cobra.Command, args []string) {
 		return
 	}
 
-	if helpTopic := command.Annotations["helpTopic"]; helpTopic == "true" {
-		fmt.Fprint(command.OutOrStdout(), command.Long)
-		return
-	}
-
 	coreCommands := []string{}
 	additionalCommands := []string{}
 	for _, c := range command.Commands() {
diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go
@@ -1,41 +1,76 @@
 package root
 
 import (
+	"fmt"
+
 	"github.com/MakeNowJust/heredoc"
 	"github.com/spf13/cobra"
 )
 
 func NewHelpTopic(topic string) *cobra.Command {
-	return &cobra.Command{
-		Use: "environment",
-		Long: heredoc.Doc(`
-			GITHUB_TOKEN: an authentication token for github.com API requests. Setting this avoids
-			being prompted to authenticate and takes precedence over previously stored credentials.
+	topicContent := make(map[string]string)
+
+	topicContent["environment"] = heredoc.Doc(`
+		GITHUB_TOKEN: an authentication token for github.com API requests. Setting this avoids
+		being prompted to authenticate and takes precedence over previously stored credentials.
 
-			GITHUB_ENTERPRISE_TOKEN: an authentication token for API requests to GitHub Enterprise.
+		GITHUB_ENTERPRISE_TOKEN: an authentication token for API requests to GitHub Enterprise.
 
-			GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands
-			that otherwise operate on a local repository.
+		GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands
+		that otherwise operate on a local repository.
 
-			GH_HOST: specify the GitHub hostname for commands that would otherwise assume
-			the "github.com" host when not in a context of an existing repository.
+		GH_HOST: specify the GitHub hostname for commands that would otherwise assume
+		the "github.com" host when not in a context of an existing repository.
 
-			GH_EDITOR, GIT_EDITOR, VISUAL, EDITOR (in order of precedence): the editor tool to use
-			for authoring text.
+		GH_EDITOR, GIT_EDITOR, VISUAL, EDITOR (in order of precedence): the editor tool to use
+		for authoring text.
 
-			BROWSER: the web browser to use for opening links.
+		BROWSER: the web browser to use for opening links.
 
-			DEBUG: set to any value to enable verbose output to standard error. Include values "api"
-			or "oauth" to print detailed information about HTTP requests or authentication flow.
+		DEBUG: set to any value to enable verbose output to standard error. Include values "api"
+		or "oauth" to print detailed information about HTTP requests or authentication flow.
 
-			GLAMOUR_STYLE: the style to use for rendering Markdown. See
-			https://github.com/charmbracelet/glamour#styles
+		GLAMOUR_STYLE: the style to use for rendering Markdown. See
+		https://github.com/charmbracelet/glamour#styles
 
-			NO_COLOR: avoid printing ANSI escape sequences for color output.
-		`),
+		NO_COLOR: avoid printing ANSI escape sequences for color output.
+	`)
+
+	cmd := &cobra.Command{
+		Use:    topic,
+		Long:   topicContent[topic],
 		Hidden: true,
-		Annotations: map[string]string{
-			"helpTopic": "true",
-		},
+		Args:   cobra.NoArgs,
+	}
+
+	cmd.SetHelpFunc(helpTopicHelpFunc)
+	cmd.SetUsageFunc(helpTopicUsageFunc)
+
+	return cmd
+}
+
+func helpTopicHelpFunc(command *cobra.Command, args []string) {
+	if len(args) >= 2 && args[1] != "--help" && args[1] != "-h" {
+		command.Printf("unknown command %q for %q\n", args[1], command.CommandPath())
+
+		if args[1] == "help" {
+			command.Print("\nDid you mean this?\n")
+			command.Printf("\t%s\n\n", "--help")
+		} else {
+			command.Printf("\n")
+		}
+
+		helpTopicUsageFunc(command)
+		command.Printf("\n")
+		hasFailed = true
+		return
 	}
+
+	fmt.Fprint(command.OutOrStdout(), command.Long)
+}
+
+func helpTopicUsageFunc(command *cobra.Command) error {
+	command.Printf("Usage:  gh help %s", command.Use)
+
+	return nil
 }
diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go
@@ -82,15 +82,15 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command {
 
 	cmdutil.DisableAuthCheck(cmd)
 
-	// CHILD COMMANDS
-
+	// Child commands
 	cmd.AddCommand(aliasCmd.NewCmdAlias(f))
 	cmd.AddCommand(authCmd.NewCmdAuth(f))
 	cmd.AddCommand(configCmd.NewCmdConfig(f))
 	cmd.AddCommand(creditsCmd.NewCmdCredits(f, nil))
 	cmd.AddCommand(gistCmd.NewCmdGist(f))
 	cmd.AddCommand(NewCmdCompletion(f.IOStreams))
 
+	// Help Topics
 	cmd.AddCommand(NewHelpTopic("environment"))
 
 	// the `api` command should not inherit any extra HTTP headers
