e87b5bcaff
* Add "reference" help topic * Only print reference as a help topic * fix for color fns, slightly generalize * WIP for switching to markdown * escape gt/lt * minor * higher wrap point * detect terminal theme * futz with angle brackets once more * minor cleanup * prepend parent commands * rename help topic fns and add test * Simplify reference help generation - the `<...>` characters from command usage line are now preserved by enclosing the entire usage synopsis in a code span - hard breaks in flag usage lines are preserved by enclosing flag usage in a code block - TTY detection and Markdown rendering are now delayed until the user explicitly requests `gh help reference` - `gh help reference` output is now pager-enabled Co-authored-by: vilmibm <vilmibm@github.com> Co-authored-by: vilmibm <vilmibm@neongrid.space> Co-authored-by: Mislav Marohnić <mislav@github.com>
80 lines
2.6 KiB
Go
80 lines
2.6 KiB
Go
package root
|
|
|
|
import (
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var HelpTopics = map[string]map[string]string{
|
|
"environment": {
|
|
"short": "Environment variables that can be used with gh",
|
|
"long": heredoc.Doc(`
|
|
GH_TOKEN, GITHUB_TOKEN (in order of precedence): an authentication token for github.com
|
|
API requests. Setting this avoids being prompted to authenticate and takes precedence over
|
|
previously stored credentials.
|
|
|
|
GH_ENTERPRISE_TOKEN, GITHUB_ENTERPRISE_TOKEN (in order of precedence): 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_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.
|
|
|
|
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.
|
|
|
|
GH_PAGER, PAGER (in order of precedence): a terminal paging program to send standard output to, e.g. "less".
|
|
|
|
GLAMOUR_STYLE: the style to use for rendering Markdown. See
|
|
https://github.com/charmbracelet/glamour#styles
|
|
|
|
NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.
|
|
|
|
CLICOLOR: set to "0" to disable printing ANSI colors in output.
|
|
|
|
CLICOLOR_FORCE: set to a value other than "0" to keep ANSI colors in output
|
|
even when the output is piped.
|
|
|
|
GH_NO_UPDATE_NOTIFIER: set to any value to disable update notifications. By default, gh
|
|
checks for new releases once every 24 hours and displays an upgrade notice on standard
|
|
error if a newer version was found.
|
|
`),
|
|
},
|
|
"reference": {
|
|
"short": "A comprehensive reference of all gh commands",
|
|
},
|
|
}
|
|
|
|
func NewHelpTopic(topic string) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: topic,
|
|
Short: HelpTopics[topic]["short"],
|
|
Long: HelpTopics[topic]["long"],
|
|
Hidden: true,
|
|
Annotations: map[string]string{
|
|
"markdown:generate": "true",
|
|
"markdown:basename": "gh_help_" + topic,
|
|
},
|
|
}
|
|
|
|
cmd.SetHelpFunc(helpTopicHelpFunc)
|
|
cmd.SetUsageFunc(helpTopicUsageFunc)
|
|
|
|
return cmd
|
|
}
|
|
|
|
func helpTopicHelpFunc(command *cobra.Command, args []string) {
|
|
command.Print(command.Long)
|
|
}
|
|
|
|
func helpTopicUsageFunc(command *cobra.Command) error {
|
|
command.Printf("Usage: gh help %s", command.Use)
|
|
return nil
|
|
}
|