goconfigure

May 20, 2021

Changes in this version

type OptionSet

+ Flag func(i interface{}, name rune, description string) *Option

+ Option func(i, d interface{}, name, description string) *Option

type Options

+ func (o *Options) Flag(i interface{}, name rune, description string) *Option

+ func (o *Options) Option(i, d interface{}, name, description string) *Option

+ func (o *Options) ToEnv(name string) string

May 19, 2021

Changes in this version

+ type NullReporter struct

+ func (NullReporter) Report(string, map[string]interface{})

May 18, 2021

Changes in this version

+ const SET

+ const UNSET

Apr 13, 2021

Changes in this version

+ var ErrConversionFailure = errors.New("cannot convert config type")

+ var ErrFailedToReadURI = errors.New("failed to read URI for config file")

+ var ErrFlagError = errors.New("flag parse error")

+ var ErrInvalidDataFormat = errors.New("invalid data format")

+ var ErrInvalidDataType = errors.New("invalid data type")

+ var ErrInvalidDefault = errors.New("cannot use default option")

+ var ErrInvalidDuration = errors.New("invalid duration value")

+ var ErrInvalidTypeOption = errors.New("invalid option type for flag")

+ var ErrLoadingConfig = errors.New("error loading config")

+ var ErrNoPointer = errors.New("no pointer set on option")

+ var ErrNotPointer = errors.New("incorrect type on option")

+ var ErrParsingConfig = errors.New("error parsing config")

+ type Block interface

+ Data func() interface{}

+ Description func() string

+ Register func(opts OptionSet)

+ type ConsoleReporter struct

+ func (c ConsoleReporter) Report(description string, data map[string]interface{})

type Env

+ Stub string

type External

+ func (e *External) Value(o *Option) (value.Data, error)

+ type LogrusReporter struct

+ Logger *logrus.Logger

+ func (l LogrusReporter) Report(description string, data map[string]interface{})

+ type OptionSet interface

+ Add func(option *Option)

type Options

+ Stub string

+ type Reporter interface

+ Report func(description string, data map[string]interface{})

+ type Settings struct

+ Blocks []Block

+ Help bool

+ Options *Options

+ func NewSettings(stub string) *Settings

+ func (s *Settings) Add(block Block)

+ func (s *Settings) AddConfigFile()

+ func (s *Settings) AddHelp()

+ func (s *Settings) Parse(reporter Reporter) error

+ func (s *Settings) ParseUsing(args []string, reporter Reporter) error

Feb 5, 2021

Changes in this version

+ var Help bool

type Option

+ func HelpOption() *Option

Jan 25, 2021

Changes in this version

+ func Sanitise(v, set, unset interface{}) string

Jan 7, 2021

Changes in this version

+ type Env struct

+ Data map[string]value.Data

+ func NewEnv() *Env

+ func (e *Env) Register(o *Option) error

+ type External struct

+ Data map[string]value.Data

+ func NewExternal() *External

+ func (e *External) Load(uri string) error

+ func (e *External) Register(o *Option) error

+ type Flags struct

+ Data map[string]value.Data

+ func NewFlags() *Flags

+ func (f *Flags) Parse(args []string) error

+ func (f *Flags) Register(o *Option) error

type Option

+ Description string

+ Pointer interface{}

+ func NewFlag(i interface{}, name rune, description string) *Option

+ func (o *Option) Check() error

+ func (o *Option) Set(short, long, env, external value.Data) error

+ func (o *Option) Usage() string

type Options

+ func (o *Options) LoadUsing(option *Option)

Oct 30, 2020

Changes in this version

+ func Load(uri string, target interface{}) error

Nov 14, 2019

Changes in this version

+ type Option interface

+ ConfigKey func(name string)

+ Default func(value interface{})

+ EnvVar func(name string)

+ Flags func(short rune, longFlag string)

+ LongFlag func(name string)

+ Parse func(config map[string]interface{}) error

+ RegisterFlags func(flags *flag.FlagSet) error

+ ShortFlag func(name rune)

+ String func() string

+ Value func() value.Data

+ func NewOption(i interface{}, description string) Option

+ type Options interface

+ Add func(option Option)

+ Args func() []string

+ NArg func() int

+ Parse func(config map[string]interface{}) error

+ ParseUsing func(option Option) error

+ Usage func()

+ UsageString func() string

+ func NewOptions() Options

+ func NewOptionsWithArgs(args []string) Options