Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DefineFlagsFn ¶
DefineFlagsFn is intended to set flags via flag.FlagSet and returns a new Holder, where pointers to them are meant to be stored, along with ValidateFlagsFn, if any, or nil:
type CmdHolder struct{ key *string }
f := func(*flag.FlagSet) (CmdHolder, ValidateFlagsFn[CmdHolder]) {
return CmdHolder{
key: set.String("key", "A", "a kind of key"),
},
func(set *flag.FlagSet, holder *CmdHolder) error {
if len(*holder.key) > 1 {
return errors.New("key must contain one character")
}
return nil
}
}
type Option ¶
type Option func(r runner)
func WithFlagSet ¶
func WithFlagSet( name string, errorHandling flag.ErrorHandling, ) Option
WithFlagSet is an Option that initializes flag.FlagSet with the given name and error handling policy.
func WithFlags ¶
WithFlags is an Option that calls the given DefineFlagsFn function and saves its returned values in Runner.
func WithLoggerOptions ¶
WithLoggerOptions is an Option that adds extra zap.Option's to build the logger.
func WithUsage ¶
func WithUsage(f UsageFn) Option
WithUsage is an Option that sets flag.FlagSet.Usage.
type Runner ¶
type Runner[Holder any] struct { // contains filtered or unexported fields }
Runner is a helper struct for command-line programs.
func New ¶
New creates a new Runner with optional Option's.
It defines a new flag.FlagSet with default options:
- "loglevel" to set the logging level (default: the Info level);
- "verbose" for verbose output (the logging level will be overwritten to the Debug level);
- "color" for colorful output (default: depends on your terminal).
Options:
- WithFlagSet, otherwise, the default flag.FlagSet uses an empty name and the flag.ContinueOnError error handling policy;
- WithUsage, otherwise, the flag.FlagSet uses flag.DefaultUsage;
- WithFlags, otherwise, no additional flags other than the default ones will be set.
- WithLoggerOptions.
type UsageFn ¶
UsageFn is intended to set the flag.FlagSet behaviour when flag.FlagSet.Usage is called.
type ValidateFlagsFn ¶
ValidateFlagsFn is intended to be a validator for flags of flag.FlagSet.
Source Files