flags

Documentation

Index

• Variables
• func FlagCategory(flag cli.Flag, flagGroups []FlagGroup) string
• func NewApp(gitCommit, gitDate, usage string) *cli.App
• type ByCategory
  • func (a ByCategory) Len() int
  • func (a ByCategory) Less(i, j int) bool
  • func (a ByCategory) Swap(i, j int)
• type FlagGroup
• type HelpData

Variables

var (
	CommandHelpTemplate = `` /* 473-byte string literal not displayed */

	OriginCommandHelpTemplate = `` /* 340-byte string literal not displayed */

	// AppHelpTemplate is the test template for the default, global app help topic.
	AppHelpTemplate = `` /* 685-byte string literal not displayed */

	// ClefAppHelpTemplate is the template for the default, global app help topic.
	ClefAppHelpTemplate = `` /* 540-byte string literal not displayed */

)

Functions

func FlagCategory

func FlagCategory(flag cli.Flag, flagGroups []FlagGroup) string

func NewApp

func NewApp(gitCommit, gitDate, usage string) *cli.App

NewApp creates an app with sane defaults.

Types

type ByCategory

type ByCategory []FlagGroup

byCategory sorts an array of FlagGroup by Name in the order defined in AppHelpFlagGroups.

func (ByCategory) Len

func (a ByCategory) Len() int

func (ByCategory) Less

func (a ByCategory) Less(i, j int) bool

func (ByCategory) Swap

func (a ByCategory) Swap(i, j int)

type FlagGroup

type FlagGroup struct {
	Name  string
	Flags []cli.Flag
}

FlagGroup is a collection of flags belonging to a single topic.

type HelpData

type HelpData struct {
	App        interface{}
	FlagGroups []FlagGroup
}

HelpData is a one shot struct to pass to the usage template