templates

Documentation

Index

• func GenerateFromBaseTemplate(commandName string, parts []HelpTemplateSections) string
• func SetCustomUsageFunc(cmd *cobra.Command) error
• func WrappedFlagUsages(f *pflag.FlagSet) string
• type HelpFlagPrinter
  • func NewHelpFlagPrinter(out io.Writer, wrapLimit uint, flags *pflag.FlagSet) (*HelpFlagPrinter, error)
  • func (p *HelpFlagPrinter) PrintHelpFlag(flag *pflag.Flag)
• type HelpTemplateSections
• type Templater

Functions

func GenerateFromBaseTemplate

func GenerateFromBaseTemplate(commandName string, parts []HelpTemplateSections) string

func SetCustomUsageFunc

func SetCustomUsageFunc(cmd *cobra.Command) error

SetCustomUsageFunc configures a custom usage template for the provided cobra command. It returns an error if the command is nil.

func WrappedFlagUsages

func WrappedFlagUsages(f *pflag.FlagSet) string

WrappedFlagUsages formats the flag usage string to fit within the terminal width

Types

type HelpFlagPrinter

type HelpFlagPrinter struct {
	// contains filtered or unexported fields
}

func NewHelpFlagPrinter

func NewHelpFlagPrinter(out io.Writer, wrapLimit uint, flags *pflag.FlagSet) (*HelpFlagPrinter, error)

func (*HelpFlagPrinter) PrintHelpFlag

func (p *HelpFlagPrinter) PrintHelpFlag(flag *pflag.Flag)

type HelpTemplateSections

type HelpTemplateSections int

const (
	LongDescription HelpTemplateSections = iota
	Usage
	Aliases
	Examples
	AvailableCommands
	Flags
	GlobalFlags
	AdditionalHelpTopics
	NativeCommands
	DoubleDashHelp
	Footer
)

type Templater

type Templater struct {
	UsageTemplate string
}

Templater handles the generation and management of command usage templates.