flags

package

v0.2.1455559 Latest Latest Go to latest Published: Mar 25, 2022 License: GPL-3.0 Imports: 4 Imported by: 0

Details

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

Repository

github.com/StevenBarnett1/bor

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FlagCategory(flag cli.Flag, flagGroups []FlagGroup) string
func NewApp(gitCommit, gitDate, usage string) *cli.App
type ByCategory
type FlagGroup
type HelpData

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	CommandHelpTemplate = `` /* 477-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 = `` /* 687-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

Source Files ¶

View all Source files

helpers.go

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