multica/server/cmd/multica/help.go

package main

import (
	"fmt"
	"strings"
	"text/template"

	"github.com/spf13/cobra"
)

// Command group IDs used across the CLI.
const (
	groupCore       = "core"
	groupRuntime    = "runtime"
	groupAdditional = "additional"
)

// errSilent is returned when the error message has already been printed.
var errSilent = fmt.Errorf("")

// exactArgs returns a cobra.PositionalArgs that validates the arg count
// and prints help on failure, so users see usage context with the error.
func exactArgs(n int) cobra.PositionalArgs {
	return func(cmd *cobra.Command, args []string) error {
		if len(args) != n {
			if n == 1 {
				fmt.Fprintf(cmd.ErrOrStderr(), "Error: accepts 1 arg, received %d\n\n", len(args))
			} else {
				fmt.Fprintf(cmd.ErrOrStderr(), "Error: accepts %d args, received %d\n\n", n, len(args))
			}
			cmd.Help()
			return errSilent
		}
		return nil
	}
}


// initHelp configures the root command to use gh-style help output.
func initHelp(root *cobra.Command) {
	root.SetHelpTemplate(rootHelpTemplate)
	root.SetUsageTemplate(rootHelpTemplate)
	root.CompletionOptions.HiddenDefaultCmd = true

	root.AddGroup(
		&cobra.Group{ID: groupCore, Title: "CORE COMMANDS"},
		&cobra.Group{ID: groupRuntime, Title: "RUNTIME COMMANDS"},
		&cobra.Group{ID: groupAdditional, Title: "ADDITIONAL COMMANDS"},
	)

	// Apply gh-style templates to all commands recursively.
	applyTemplates(root)
}

func applyTemplates(cmd *cobra.Command) {
	for _, c := range cmd.Commands() {
		if c.HasSubCommands() {
			c.SetHelpTemplate(subHelpTemplate)
			c.SetUsageTemplate(subHelpTemplate)
		} else {
			c.SetHelpTemplate(leafHelpTemplate)
			c.SetUsageTemplate(leafHelpTemplate)
		}
		applyTemplates(c)
	}
}

// formatCommandList formats a list of commands in "name:  description" style
// with automatic alignment, matching gh's output.
func formatCommandList(cmds []*cobra.Command) string {
	if len(cmds) == 0 {
		return ""
	}

	maxLen := 0
	for _, c := range cmds {
		if c.IsAvailableCommand() && len(c.Name()) > maxLen {
			maxLen = len(c.Name())
		}
	}

	var b strings.Builder
	for _, c := range cmds {
		if !c.IsAvailableCommand() {
			continue
		}
		padding := strings.Repeat(" ", maxLen-len(c.Name()))
		fmt.Fprintf(&b, "  %s:%s  %s\n", c.Name(), padding, c.Short)
	}
	return b.String()
}

// commandsInGroup returns commands that belong to a specific group.
func commandsInGroup(cmds []*cobra.Command, groupID string) []*cobra.Command {
	var result []*cobra.Command
	for _, c := range cmds {
		if c.GroupID == groupID && c.IsAvailableCommand() {
			result = append(result, c)
		}
	}
	return result
}

func init() {
	cobra.AddTemplateFuncs(template.FuncMap{
		"formatCommandList": formatCommandList,
		"commandsInGroup":   commandsInGroup,
	})
}

var rootHelpTemplate = `Work seamlessly with Multica from the command line.

USAGE
  multica <command> <subcommand> [flags]
{{range .Groups}}
{{.Title}}
{{formatCommandList (commandsInGroup $.Commands .ID)}}
{{- end}}
FLAGS
{{.LocalFlags.FlagUsages}}
EXAMPLES
  $ multica login
  $ multica issue list --output json
  $ multica daemon start
  $ multica agent list --output json

ENVIRONMENT VARIABLES
  MULTICA_SERVER_URL    Override the default server URL
  MULTICA_WORKSPACE_ID  Set the active workspace

LEARN MORE
  Use ` + "`multica <command> <subcommand> --help`" + ` for more information about a command.
`

var subHelpTemplate = `{{.Short}}

USAGE
  {{.CommandPath}} <command> [flags]

COMMANDS
{{formatCommandList .Commands}}
INHERITED FLAGS
  --help   Show help for command
{{- if .Example}}

EXAMPLES
{{.Example}}
{{- end}}

LEARN MORE
  Use ` + "`{{.CommandPath}} <command> --help`" + ` for more information about a command.
`

var leafHelpTemplate = `{{if .Long}}{{.Long}}{{else}}{{.Short}}{{end}}

USAGE
  {{.UseLine}}
{{- if .HasLocalFlags}}

FLAGS
{{.LocalFlags.FlagUsages}}
{{- end}}
INHERITED FLAGS
  --help   Show help for command
{{- if .Example}}

EXAMPLES
{{.Example}}
{{- end}}

LEARN MORE
  Use ` + "`multica <command> <subcommand> --help`" + ` for more information about a command.
`