config

README

Go Config

configuration library in go

Get it

go get github.com/patrickhuber/go-config

Example

config.yml

yaml: yes

config.json

{"json": "yes"}

config.toml

toml="yes"

.env

dotenv="yes"

package main
import (
    "fmt"
    "log"
    "github.com/patrickhuber/go-config"
    "github.com/patrickhuber/go-cross"
    "github.com/patrickhuber/go-cross/arch"
    "github.com/patrickhuber/go-cross/platform"
)
func main(){
    args := []string{"--hello", "world"}

    // Create a target for cross-platform abstractions
    target := cross.NewTest(platform.Linux, arch.AMD64)
    filesystem := target.FS()

    // Use environment provider from target and set environment variable
    osEnv := target.Env()
    osEnv.Set("env", "yes")

    builder := config.NewBuilder(
        config.NewYaml(filesystem, "config.yml"),
        config.NewJson(filesystem, "config.json"),
        config.NewToml(filesystem, "config.toml"),
        config.NewEnv(osEnv, config.EnvOption{Prefix: "env"}),
        config.NewDotEnv(filesystem, ".env"),
        config.NewFlag([]config.Flag{
            &config.StringFlag{
                Name: "hello",
            },
        }, args),
    )
    root := builder.Build()
    cfg, err := root.Get(&config.GetContext{})
    if err != nil {
        log.Fatal(err)
    } else {
        log.Printf("%v", cfg)
    }
}

output

yaml: yes
json: yes
toml: yes
dotenv: yes
env: yes

Documentation

Overview

Example

args := []string{"--hello", "world"}

// Create a target for cross-platform abstractions
target := cross.NewTest(platform.Linux, arch.AMD64)
filesystem := target.FS()

// Use environment provider from target and set environment variable
osEnv := target.Env()
osEnv.Set("env", "yes")

builder := config.NewBuilder(
	config.NewYaml(filesystem, "config.yml"),
	config.NewJson(filesystem, "config.json"),
	config.NewToml(filesystem, "config.toml"),
	config.NewEnv(osEnv, config.EnvOption{Prefix: "env"}),
	config.NewDotEnv(filesystem, ".env"),
	config.NewFlag([]config.Flag{
		&config.StringFlag{
			Name: "hello",
		},
	}, args),
)
root := builder.Build()
cfg, err := root.Get(&config.GetContext{})
if err != nil {
	log.Fatal(err)
} else {
	log.Printf("%v", cfg)
}

Index

• Constants
• func Merge(from any, to any) (any, error)
• type Builder
  • func NewBuilder(providers ...Provider) *Builder
  • func (b *Builder) Build() Root
  • func (b *Builder) With(provider Provider) *Builder
• type Change
  • func Diff(from, to any) ([]Change, error)
• type ChangeType
• type Codec
  • func NewJsonCodec() Codec
  • func NewTomlCodec() Codec
  • func NewYamlCodec() Codec
• type DynamicResolver
• type EnvOption
• type EnvProvider
  • func NewEnv(environment env.Environment, options ...EnvOption) *EnvProvider
  • func (p *EnvProvider) Get(ctx *GetContext) (any, error)
• type FileBeforeGet
• type FileOption
• type Flag
• type FlagOption
• type GetContext
• type GlobOption
• type GlobProviderResolver
• type JsonOption
• type Marshaler
• type Provider
  • func NewDotEnv(filesystem fs.FS, file string, options ...FileOption) Provider
  • func NewDynamic(resolver DynamicResolver) Provider
  • func NewFile(filesystem fs.FS, file string, codec Codec, options ...FileOption) Provider
  • func NewFlag(flags []Flag, args []string, options ...FlagOption) Provider
  • func NewGlob(filesystem fs.FS, filePath filepath.Provider, directory string, pattern string, ...) Provider
  • func NewGlobUp(filesystem fs.FS, filePath filepath.Provider, directory string, pattern string, ...) Provider
  • func NewJson(filesystem fs.FS, file string, options ...FileOption) Provider
  • func NewMemory(memory any, transformers ...Transformer) Provider
  • func NewToml(filesystem fs.FS, file string, options ...FileOption) Provider
  • func NewYaml(filesystem fs.FS, file string, options ...FileOption) Provider
  • func TransformProvider(transform func(any) (any, error)) Provider
• type Root
  • func NewRoot(providers ...Provider) Root
• type SetContext
• type StringFlag
  • func (s *StringFlag) Set(value string) error
  • func (s *StringFlag) String() string
  • func (s *StringFlag) Value() any
• type StringSliceFlag
  • func (s *StringSliceFlag) Set(value string) error
  • func (s *StringSliceFlag) String() string
  • func (s *StringSliceFlag) Value() any
• type Transformer
  • func FuncTransformer(transform func(any) (any, error)) Transformer
  • func FuncTypedTransformer[T any](transform func(T) (T, error)) Transformer
• type Unmarshaler

Examples

• Package

Constants

const (
	Create changeType = "create"
	Update changeType = "update"
	Delete changeType = "delete"
)

Functions

func Merge

func Merge(from any, to any) (any, error)

Types

type Builder

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

func NewBuilder

func NewBuilder(providers ...Provider) *Builder

func (*Builder) Build

func (b *Builder) Build() Root

func (*Builder) With

func (b *Builder) With(provider Provider) *Builder

type Change

type Change struct {
	ChangeType ChangeType
	Path       []string
	From       any
	To         any
}

func Diff

func Diff(from, to any) ([]Change, error)

type ChangeType

type ChangeType interface {
	// contains filtered or unexported methods
}

type Codec

type Codec interface {
	Marshaler
	Unmarshaler
}

func NewJsonCodec

func NewJsonCodec() Codec

func NewTomlCodec

func NewTomlCodec() Codec

func NewYamlCodec

func NewYamlCodec() Codec

type DynamicResolver

type DynamicResolver func(ctx *GetContext) (Provider, error)

type EnvOption

type EnvOption struct {
	Prefix       string
	Transformers []Transformer
}

type EnvProvider

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

func NewEnv

func NewEnv(environment env.Environment, options ...EnvOption) *EnvProvider

func (*EnvProvider) Get

func (p *EnvProvider) Get(ctx *GetContext) (any, error)

type FileBeforeGet

type FileBeforeGet func(ctx *GetContext, provider Provider, file string) (any, error)

type FileOption

type FileOption struct {
	Transformers []Transformer
	BeforeGet    FileBeforeGet
}

type Flag

type Flag interface {
	Set(value string) error
	String() string
	Value() any
}

type FlagOption

type FlagOption struct {
	Transformers []Transformer
}

type GetContext

type GetContext struct {
	MergedConfiguration any
}

type GlobOption

type GlobOption struct {
	Transformers []Transformer
	Resolver     GlobProviderResolver
}

type GlobProviderResolver

type GlobProviderResolver func(filesystem fs.FS, match string) Provider

GlobProviderResolver returns the Provider for the given glob match

type JsonOption

type JsonOption struct {
	Transformers []Transformer
}

type Marshaler

type Marshaler interface {
	Marshal(data any) ([]byte, error)
}

type Provider

type Provider interface {
	Get(ctx *GetContext) (any, error)
}

func NewDotEnv

func NewDotEnv(filesystem fs.FS, file string, options ...FileOption) Provider

func NewDynamic

func NewDynamic(resolver DynamicResolver) Provider

func NewFile

func NewFile(filesystem fs.FS, file string, codec Codec, options ...FileOption) Provider

func NewFlag

func NewFlag(flags []Flag, args []string, options ...FlagOption) Provider

func NewGlob

func NewGlob(filesystem fs.FS, filePath filepath.Provider, directory string, pattern string, options ...GlobOption) Provider

func NewGlobUp

func NewGlobUp(filesystem fs.FS, filePath filepath.Provider, directory string, pattern string, options ...GlobOption) Provider

func NewJson

func NewJson(filesystem fs.FS, file string, options ...FileOption) Provider

func NewMemory

func NewMemory(memory any, transformers ...Transformer) Provider

func NewToml

func NewToml(filesystem fs.FS, file string, options ...FileOption) Provider

func NewYaml

func NewYaml(filesystem fs.FS, file string, options ...FileOption) Provider

func TransformProvider

func TransformProvider(transform func(any) (any, error)) Provider

type Root

type Root interface {
	Provider
	Providers() []Provider
}

func NewRoot

func NewRoot(providers ...Provider) Root

type SetContext

type SetContext struct{}

type StringFlag

type StringFlag struct {
	Name    string
	Default string
	Usage   string
	// contains filtered or unexported fields
}

func (*StringFlag) Set

func (s *StringFlag) Set(value string) error

func (*StringFlag) String

func (s *StringFlag) String() string

func (*StringFlag) Value

func (s *StringFlag) Value() any

type StringSliceFlag

type StringSliceFlag struct {
	Name    string
	Default []string
	Usage   string
	// contains filtered or unexported fields
}

func (*StringSliceFlag) Set

func (s *StringSliceFlag) Set(value string) error

func (*StringSliceFlag) String

func (s *StringSliceFlag) String() string

func (*StringSliceFlag) Value

func (s *StringSliceFlag) Value() any

type Transformer

type Transformer interface {
	Transform(instance any) (any, error)
}

func FuncTransformer

func FuncTransformer(transform func(any) (any, error)) Transformer

func FuncTypedTransformer

func FuncTypedTransformer[T any](transform func(T) (T, error)) Transformer

type Unmarshaler

type Unmarshaler interface {
	Unmarshal(buf []byte) (any, error)
}