command

Documentation

Index

• func DoNothing(_ flag.PassedFlags) error
• type Action
• type Command
  • func New(helpShort HelpShort, action Action, opts ...CommandOpt) Command
• type CommandMap
  • func (fm CommandMap) Empty() bool
  • func (fm CommandMap) SortedNames() []Name
• type CommandOpt
  • func ExistingFlag(name flag.Name, value flag.Flag) CommandOpt
  • func ExistingFlags(flagMap flag.FlagMap) CommandOpt
  • func Flag(name flag.Name, helpShort flag.HelpShort, empty value.EmptyConstructor, ...) CommandOpt
  • func Footer(footer string) CommandOpt
  • func HelpLong(helpLong string) CommandOpt
• type HelpShort
• type Name

Functions

func DoNothing

func DoNothing(_ flag.PassedFlags) error

DoNothing is a command action that simply returns nil Useful for prototyping

Types

type Action

type Action func(flag.PassedFlags) error

An Action is run as the result of a command

type Command

type Command struct {
	Action Action
	Flags  flag.FlagMap
	// HelpShort is a required one-line description
	HelpShort HelpShort
	// Footer is yet another optional longer description.
	Footer string
	// HelpLong is an optional longer description
	HelpLong string
}

A Command will run code for you! The name of a Command should probably be a verb - add , edit, run, ... A Command should not be constructed directly. Use Command / New / ExistingCommand functions

func New

func New(helpShort HelpShort, action Action, opts ...CommandOpt) Command

New builds a Command

type CommandMap

type CommandMap map[Name]Command

A CommandMap holds Commands and is used by Sections

func (CommandMap) Empty

func (fm CommandMap) Empty() bool

func (CommandMap) SortedNames

func (fm CommandMap) SortedNames() []Name

type CommandOpt

type CommandOpt func(*Command)

A CommandOpt customizes a Command

func ExistingFlag

func ExistingFlag(name flag.Name, value flag.Flag) CommandOpt

ExistingFlag adds an existing flag to a Command. It panics if a flag with the same name exists

func ExistingFlags

func ExistingFlags(flagMap flag.FlagMap) CommandOpt

func Flag

func Flag(name flag.Name, helpShort flag.HelpShort, empty value.EmptyConstructor, opts ...flag.FlagOpt) CommandOpt

Flag builds a flag and adds it to a Command. It panics if a flag with the same name exists

func Footer

func Footer(footer string) CommandOpt

Footer adds an Help string to the command - useful from a help function

func HelpLong

func HelpLong(helpLong string) CommandOpt

HelpLong adds an Help string to the command - useful from a help function

type HelpShort

type HelpShort string

type Name

type Name string

Name of the command