feat: improve config setup (#9)

Signed-off-by: Tronje Krop <[email protected]>

Makefile

@@ -12,7 +12,7 @@ export GOPATH ?= $(shell $(GO) env GOPATH)
 export GOBIN ?= $(GOPATH)/bin
 
 # Setup go-make version to use desired build and config scripts.
-GOMAKE_DEP ?= github.com/tkrop/[email protected].97
+GOMAKE_DEP ?= github.com/tkrop/[email protected].98
 INSTALL_FLAGS ?= -mod=readonly -buildvcs=auto
 # Request targets from go-make targets target.
 TARGETS := $(shell command -v $(GOBIN)/go-make >/dev/null || \

README.md

@@ -136,7 +136,7 @@ The [`go-config`][go-config] framework supports to set up a [logrus][logrus]
 `Logger`_out-of-the-box using the following two approaches:
 
 ```go
-    config := config.SetupLogger(logger)
+    logger := config.SetupLogger(log.New())
 
     logger := config.Log.Setup(log.New())
 ```

VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

config/config.go

@@ -35,10 +35,8 @@ type Config struct {
 }
 
 // SetupLogger is a convenience method to setup the logger.
-func (c *Config) SetupLogger(logger *log.Logger) *Config {
-	c.Log.Setup(logger)
-
-	return c
+func (c *Config) SetupLogger(logger *log.Logger) *log.Logger {
+	return c.Log.Setup(logger)
 }
 
 // Reader common config reader based on viper.
@@ -62,7 +60,7 @@ func GetEnvName(prefix string, name string) string {
 // config values to initialize the map. The `default` tags are only used, if
 // the config values are zero.
 func New[C any](
-	prefix, name string, config *C,
+	prefix, name string,
 ) *Reader[C] {
 	r := &Reader[C]{
 		Viper: viper.New(),
@@ -75,7 +73,7 @@ func New[C any](
 	r.SetConfigName(GetEnvName(prefix, name))
 	r.SetConfigType("yaml")
 	r.AddConfigPath(".")
-	r.SetSubDefaults("", config, true)
+	r.SetSubDefaults("", new(C), true)
 
 	return r
 }

config/config_test.go

@@ -91,7 +91,7 @@ func TestConfig(t *testing.T) {
 			if param.setenv != nil {
 				param.setenv(t)
 			}
-			reader := config.New("TC", "test", &config.Config{}).
+			reader := config.New[config.Config]("TC", "test").
 				SetDefaults(param.setup)
 
 			// When
@@ -108,7 +108,7 @@ func TestSetupLogger(t *testing.T) {
 
 	// Given
 	logger := log.New()
-	config := config.New("TC", "test", &config.Config{}).
+	config := config.New[config.Config]("TC", "test").
 		SetDefaults(func(r *config.Reader[config.Config]) {
 			r.AddConfigPath("fixtures")
 			r.SetDefault("log.level", "trace")

log/log_test.go

@@ -85,7 +85,7 @@ func TestSetup(t *testing.T) {
 		Run(func(t test.Test, param setupParams) {
 			// Given
 			logger := log.New()
-			config := config.New("TEST", "test", &config.Config{}).
+			config := config.New[config.Config]("TEST", "test").
 				SetSubDefaults("log", param.config, false).
 				GetConfig(t.Name())
 
@@ -102,7 +102,7 @@ func TestSetup(t *testing.T) {
 
 func TestSetupNil(t *testing.T) {
 	// Given
-	config := config.New("TEST", "test", &config.Config{}).
+	config := config.New[config.Config]("TEST", "test").
 		GetConfig(t.Name())
 
 	// When