package database
// Config holds the database configurations.
type Config struct {
  Address  string `default:"localhost"`
  Port     string `default:"28015"`
  Database string `default:"my-project"`
}

package redis
// Config describes the requirement for redis client.
type Config struct {
  Address  string        `default:"redis-master"`
  Port     string        `default:"6379"`
  Password string        `secret:""`
  DB       int           `default:"0"`
  Expire   time.Duration `default:"5s"`
}

package main
import (
	"encoding/json"
	"fmt"
	"os"
	"github.com/omeid/uconfig"
	"github.com/omeid/uconfig/examples/sample/database"
	"github.com/omeid/uconfig/examples/sample/redis"
)
// Config is our application config.
type Config struct {
	// yes you can have slices.
	Hosts []string `default:"localhost,localhost.local" usage:"the ip or domains to bind to"`
	Redis    redis.Config
	Database database.Config
	// the flags plugin allows capturing a single Command after the flags.
	// so you can run myprogram -flag=value -s -blah=bleh stop|start|stop and so on.
	Mode string `default:"start" flag:",command" usage:"run|start|stop"`
}
var files = uconfig.Files{
	{Path: "/etc/demo-app/config.json", Unmarshal: json.Unmarshal, Optional: true},
	{Path: "config.json", Unmarshal: json.Unmarshal, Optional: true},
	// or short form {"config.json", json.Unmarshal, true},
	// And, of course, you can of course add as many files
	// as you want, and they will be applied
	// in the given order.
}
var conf = uconfig.Classic[Config](files)
func main() {
	conf := conf.Run()
	// use conf as you please.
	// let's pretty print it as JSON for example:
	configAsJson, err := json.MarshalIndent(conf, "", " ")
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
	fmt.Print(string(configAsJson))
}

package database
// Config holds the database configurations.
type Database struct {
  Address  string `default:"localhost"`
  Port     string `default:"28015" uconfig:".Service.Port"` // field level rename.
  Database string `default:"my-project" env:"DB_NAME" flag:"main-db-name"` // plugin specific rename.
}

package main
// Config is our application config.
type Config struct {
  // yes you can have slices.
  Hosts    []string `default:"localhost,localhost.local"`
  Redis    redis.Config
  Database database.Config
}

package users
// Config holds the database configurations.
type Config struct {
  Host string `json:"bind_addr"`
}

package main
import (
    "encoding/json"
    "fmt"
    "github.com/omeid/uconfig"
    "github.com/omeid/uconfig/plugins/secret"
    "github.com/omeid/uconfig/examples/secrets/secretsource"
)
// Creds is an example of a config struct that uses secret values.
type Creds struct {
    // by default, secret plugin will generate a name that is identical
    // to env plugin, SCREAM_SNAKE_CASE, so in this case it will be
    // APIKEY however, following the standard uConfig nesting rules
    // in Config struct below, it becomes CREDS_APIKEY.
    APIKey string `secret:""`
    // or you can provide your own name, which will not be impacted
    // by nesting or the field name.
    APIToken string `secret:"API_TOKEN"`
}
type Config struct {
    Creds Creds
}
var secrets = secret.New(func(name string) (string, error) {
    // you're free to grab the secret based on the name from wherever
    // you please, aws secrets-manager, hashicorp vault, or wherever.
    value, ok := secretsource.Get(name)
    if !ok {
        return "", secret.ErrSecretNotFound
    }
    return value, nil
})
func main() {
    // then you can use the secretPlugin with uConfig like any other plugin.
    // Lucky, uconfig.Classic allows passing more plugins, which means
    // you can simply do the following for flags, envs, files, and secrets!
    conf := uconfig.Classic[Config](nil, secrets).Run()
    fmt.Printf("we got an API Key: %s\n", conf.Creds.APIKey)
}

package something
import (
  "testing"
  "github.com/omeid/uconfig"
  "github.com/omeid/uconfig/defaults"
)
func TestSomething(t *testing.T) error {
  // It will panic on error
    conf := uconfig.Must[Conf](defaults.New())
  // Use your conf as you please.
}