Map default values, environment variables, and command-line arguments to struct tags.
go get github.com/berquerant/structconfigtype T struct {
I int `default:"10"`
}
sc := structconfig.New[T]()
var got T
if err := sc.FromDefault(&got); err != nil {
panic(err)
}
// got.I == 10type T struct {
I int `name:"int_value"`
}
os.Setenv("INT_VALUE", "10")
sc := structconfig.New[T]()
var got T
if err := sc.FromEnv(&got); err != nil {
panic(err)
}
// got.I == 10You can use WithEnvPrefix to prefix environment variable names without changing command-line flag names:
type T struct {
Port int `name:"port" default:"8080"`
}
os.Setenv("MYAPP_PORT", "9000")
sc := structconfig.New[T](structconfig.WithEnvPrefix("MYAPP_"))
var got T
if err := sc.FromEnv(&got); err != nil {
panic(err)
}
// got.Port == 9000
// Flag name remains "--port"Note on
WithPrefixvsWithEnvPrefix:
WithPrefix: adds a prefix to struct tag names (e.g.WithPrefix("app_")looks upapp_name,app_default, etc.).WithEnvPrefix: adds a prefix to environment variable names (e.g.WithEnvPrefix("MYAPP_")looks upMYAPP_<name>).When used together,
WithPrefixidentifies the tag value for the field name, andWithEnvPrefixprepends to that name when resolving environment variables.
Command-line flags (pflag)
type T struct {
I int `name:"int_value" default:"10"`
}
var fs *pflag.FlagSet = // ...
sc := structconfig.New[T]()
if err := sc.SetFlags(fs); err != nil {
panic(err)
}
if err := fs.Parse([]string{"--int_value", "100"}); err != nil {
panic(err)
}
var got T
if err := sc.FromFlags(&got, fs); err != nil {
panic(err)
}
// got.I == 100You can pass a *slog.Logger to log configuration loading and merge decisions at Debug level:
logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelDebug}))
sc := structconfig.New[T](structconfig.WithLogger(logger))
// Logs at Debug level when values are set from default, env, or flag
merger := structconfig.NewMerger[T](structconfig.WithLogger(logger))
// Logs at Debug level when fields are merged/overridden