templates

package

v1.224.0 Latest Latest Go to latest Published: Jul 23, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudposse/atmos

Links

Documentation ¶

Index ¶

func GenerateFromBaseTemplate(parts []HelpTemplateSections) string
func GetTerminalWidth() int
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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GenerateFromBaseTemplate ¶ added in v1.137.0

func GenerateFromBaseTemplate(parts []HelpTemplateSections) string

func GetTerminalWidth ¶ added in v1.148.0

func GetTerminalWidth() int

GetTerminalWidth returns the width of the terminal, defaulting to 80 if it cannot be determined. It honors an explicit COLUMNS value through the shared terminal resolver when no physical terminal size is available.

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 ¶ added in v1.137.0

type HelpTemplateSections int

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

type Templater ¶

type Templater struct {
	UsageTemplate string
}

Templater handles the generation and management of command usage templates.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
term Package term is a generated GoMock package.	Package term is a generated GoMock package.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL