option

Documentation

Overview

Package option - internal option struct and methods.

Index

• Variables
• func Sort(list []*Option)
• type Handler
• type Option
  • func New(name string, optType Type, data interface{}) *Option
  • func (opt *Option) CheckRequired() error
  • func (opt *Option) Int() int
  • func (opt *Option) Save(a ...string) error
  • func (opt *Option) SetAlias(alias ...string) *Option
  • func (opt *Option) SetBool(b bool) *Option
  • func (opt *Option) SetBoolAsOppositeToDefault() *Option
  • func (opt *Option) SetCalled(usedAlias string) *Option
  • func (opt *Option) SetDefaultStr(s string) *Option
  • func (opt *Option) SetDescription(s string) *Option
  • func (opt *Option) SetEnvVar(name string) *Option
  • func (opt *Option) SetFloat64(f float64) *Option
  • func (opt *Option) SetFloat64Slice(s []float64) *Option
  • func (opt *Option) SetHelpArgName(s string) *Option
  • func (opt *Option) SetInt(i int) *Option
  • func (opt *Option) SetIntSlice(s []int) *Option
  • func (opt *Option) SetKeyValueToStringMap(k, v string) *Option
  • func (opt *Option) SetRequired(msg string) *Option
  • func (opt *Option) SetString(s string) *Option
  • func (opt *Option) SetStringSlice(s []string) *Option
  • func (opt *Option) Synopsis()
  • func (opt *Option) ValidateMinMaxArgs() error
  • func (opt *Option) Value() interface{}
• type Type

Variables

var ErrorMissingRequiredOption = errors.New("")

var Logger = log.New(io.Discard, "DEBUG: ", log.Ldate|log.Ltime|log.Lshortfile)

Logger instance set to `io.Discard` by default. Enable debug logging by setting: `Logger.SetOutput(os.Stderr)`.

Functions

func Sort

func Sort(list []*Option)

Sort Interface

Types

type Handler

type Handler func(optName string, argument string, usedAlias string) error

Handler - Signature for the function that handles saving to the option.

type Option

type Option struct {
	Name           string
	Aliases        []string
	EnvVar         string  // Env Var that sets the option value
	Called         bool    // Indicates if the option was passed on the command line
	UsedAlias      string  // Alias/Env var used when the option was called
	Handler        Handler // method used to handle the option
	IsOptional     bool    // Indicates if an option has an optional argument
	MapKeysToLower bool    // Indicates if the option of map type has it keys set ToLower
	OptType        Type    // Option Type
	MinArgs        int     // minimum args when using multi
	MaxArgs        int     // maximum args when using multi

	IsRequired    bool   // Indicates if the option is required
	IsRequiredErr string // Error message for the required option

	// SuggestedValues used for completions, suggestions don't necessarily limit
	// the values you are able to use
	SuggestedValues []string
	ValidValues     []string // ValidValues that can be passed to Save

	// Help
	DefaultStr   string // String representation of default value
	Description  string // Optional description used for help
	HelpArgName  string // Optional arg name used for help
	HelpSynopsis string // Help synopsis

	Unknown bool // Temporary marker used during parsing

	// Verbatim text used to generate the option
	// Used in cases where the option is unknown and we eventually have to send it to the remaining slice.
	Verbatim string
	// contains filtered or unexported fields
}

Option - main object

func New

func New(name string, optType Type, data interface{}) *Option

New - Returns a new option object

func (*Option) CheckRequired

func (opt *Option) CheckRequired() error

CheckRequired - Returns error if the option is required.

func (*Option) Int

func (opt *Option) Int() int

Int - Get the option's data. Exposed due to handle increment. Maybe there is a better way.

func (*Option) Save

func (opt *Option) Save(a ...string) error

Save - Saves the data provided into the option

func (*Option) SetAlias

func (opt *Option) SetAlias(alias ...string) *Option

SetAlias - Adds aliases to an option.

func (*Option) SetBool

func (opt *Option) SetBool(b bool) *Option

SetBool - Set the option's data.

func (*Option) SetBoolAsOppositeToDefault

func (opt *Option) SetBoolAsOppositeToDefault() *Option

func (*Option) SetCalled

func (opt *Option) SetCalled(usedAlias string) *Option

SetCalled - Marks the option as called and records the alias used to call it.

func (*Option) SetDefaultStr

func (opt *Option) SetDefaultStr(s string) *Option

SetDefaultStr - Updates the DefaultStr.

func (*Option) SetDescription

func (opt *Option) SetDescription(s string) *Option

SetDescription - Updates the Description.

func (*Option) SetEnvVar

func (opt *Option) SetEnvVar(name string) *Option

SetEnvVar - Sets the name of the Env var that sets the option's value.

func (*Option) SetFloat64

func (opt *Option) SetFloat64(f float64) *Option

SetFloat64 - Set the option's data.

func (*Option) SetFloat64Slice

func (opt *Option) SetFloat64Slice(s []float64) *Option

SetFloat64Slice - Set the option's data.

func (*Option) SetHelpArgName

func (opt *Option) SetHelpArgName(s string) *Option

SetHelpArgName - Updates the HelpArgName.

func (*Option) SetInt

func (opt *Option) SetInt(i int) *Option

SetInt - Set the option's data.

func (*Option) SetIntSlice

func (opt *Option) SetIntSlice(s []int) *Option

SetIntSlice - Set the option's data.

func (*Option) SetKeyValueToStringMap

func (opt *Option) SetKeyValueToStringMap(k, v string) *Option

SetKeyValueToStringMap - Set the option's data.

func (*Option) SetRequired

func (opt *Option) SetRequired(msg string) *Option

SetRequired - Marks an option as required.

func (*Option) SetString

func (opt *Option) SetString(s string) *Option

SetString - Set the option's data.

func (*Option) SetStringSlice

func (opt *Option) SetStringSlice(s []string) *Option

SetStringSlice - Set the option's data.

func (*Option) Synopsis

func (opt *Option) Synopsis()

func (*Option) ValidateMinMaxArgs

func (opt *Option) ValidateMinMaxArgs() error

ValidateMinMaxArgs - validates that the min and max make sense.

NOTE: This should only be called to validate Repeat types.

func (*Option) Value

func (opt *Option) Value() interface{}

Value - Get untyped option value

type Type

type Type int

Type - Indicates the type of option.

const (
	BoolType Type = iota
	IncrementType

	StringType
	IntType
	Float64Type

	StringOptionalType
	IntOptionalType
	Float64OptionalType

	StringRepeatType
	IntRepeatType
	Float64RepeatType

	StringMapType
)

Option Types