config

Documentation

Index

• func StringToJsonFunc() mapstructure.DecodeHookFunc
• type ConfigFileNotFoundError
  • func (err ConfigFileNotFoundError) Error() string
  • func (err *ConfigFileNotFoundError) Unwrap() error
• type Loader
  • func NewLoader(options ...LoaderOption) *Loader
  • func (l *Loader) Load(config any) error
• type LoaderOption
  • func WithBindPFlags(pfs *pflag.FlagSet, cfg any) LoaderOption
  • func WithDecoderConfigOption(opts ...viper.DecoderConfigOption) LoaderOption
  • func WithEnvKeyReplacer(old string, new string) LoaderOption
  • func WithEnvPrefix(in string) LoaderOption
  • func WithFile(file string) LoaderOption
  • func WithName(in string) LoaderOption
  • func WithPath(in string) LoaderOption
  • func WithType(in string) LoaderOption
  • func WithViper(in *viper.Viper) LoaderOption

Functions

func StringToJsonFunc

func StringToJsonFunc() mapstructure.DecodeHookFunc

StringToJsonFunc is a mapstructure.DecodeHookFunc that converts a string to an any if the string is valid json. This is useful for unmarshalling json strings into a map. For example, if you have a struct with a field of type map[string]string like labels or annotations,

Types

type ConfigFileNotFoundError

type ConfigFileNotFoundError struct {
	// contains filtered or unexported fields
}

ConfigFileNotFoundError is returned when the config file is not found Viper will load from env or defaults

func (ConfigFileNotFoundError) Error

func (err ConfigFileNotFoundError) Error() string

func (*ConfigFileNotFoundError) Unwrap

func (err *ConfigFileNotFoundError) Unwrap() error

type Loader

type Loader struct {
	// contains filtered or unexported fields
}

func NewLoader

func NewLoader(options ...LoaderOption) *Loader

NewLoader returns a config loader with given LoaderOption(s)

func (*Loader) Load

func (l *Loader) Load(config any) error

Load loads configuration into the given mapstructure (https://github.com/mitchellh/mapstructure) from a config.yaml file and overrides with any values set in env variables

type LoaderOption

type LoaderOption func(*Loader)

func WithBindPFlags

func WithBindPFlags(pfs *pflag.FlagSet, cfg any) LoaderOption

WithBindPFlags binds viper to pflags based on the tags in the struct. Use tag `cmdx` to bind struct field to cli flag. e.g.

type Config struct {
	Host string `yaml:"host" cmdx:"host"`
}

func WithDecoderConfigOption

func WithDecoderConfigOption(opts ...viper.DecoderConfigOption) LoaderOption

WithDecoderConfigOption sets the decoder config options for viper. See https://pkg.go.dev/github.com/mitchellh/mapstructure#DecoderConfig for more details

func WithEnvKeyReplacer

func WithEnvKeyReplacer(old string, new string) LoaderOption

WithEnvKeyReplacer sets the `old` string to be replaced with the `new` string environmental variable to a key that does not match it.

func WithEnvPrefix

func WithEnvPrefix(in string) LoaderOption

WithEnvPrefix sets the prefix for keys when checking for configs in environment variables. Internally concatenates with keys with `_` in between

func WithFile

func WithFile(file string) LoaderOption

WithFile explicitly defines the path, name and extension of the config file

func WithName

func WithName(in string) LoaderOption

WithName sets the file name of the config file without the extension

func WithPath

func WithPath(in string) LoaderOption

WithPath adds config path to search the config file in, can be used multiple times to add multiple paths to search

func WithType

func WithType(in string) LoaderOption

WithType sets the type of the configuration e.g. "json", "yaml", "hcl" Also used for the extension of the file

func WithViper

func WithViper(in *viper.Viper) LoaderOption

WithViper sets the given viper instance for loading configs instead of the default configured one