conf

Documentation

Overview

Package conf contains tools for managing app configuration.

Index

• func ConfigDir(app string) string
• func ConfigFile(app string) string
• func ConfigFileFor(app string, filename string) string
• func DataDir(app string) string
• func StateDir(app string) string
• type Loader
  • func NewLoader[C any](config C, path string) *Loader[C]
  • func (l *Loader[C]) Load() (C, error)
  • func (l *Loader[C]) Reload() (C, error)

Examples

• Loader

Functions

func ConfigDir

func ConfigDir(app string) string

ConfigDir returns the path to the config dir for the app. Path precedence:

• $XDG_CONFIG_HOME/$name
• $AppData/$name (windows only)
• $HOME/.config/$name

func ConfigFile

func ConfigFile(app string) string

ConfigFile returns the default config path for the app.

func ConfigFileFor

func ConfigFileFor(app string, filename string) string

ConfigFileFor returns the config path for the app and file name.

func DataDir

func DataDir(app string) string

DataDir returns the path to the local state dir for the app. Path precedence:

• $XDG_DATA_HOME/$name
• $LocalAppData/$name (windows only)
• $HOME/.local/share/$name

func StateDir

func StateDir(app string) string

StateDir returns the path to the local state dir for the app. Path precedence:

• $XDG_STATE_HOME/$name
• $LocalAppData/$name (windows only)
• $HOME/.local/state/$name

Types

type Loader

type Loader[C any] struct {
	Config C
	Path   string
	// contains filtered or unexported fields
}

Loader populates and validates config data from a file.

Example

type Config struct {
	DatabaseURL string `default:"postgres://0.0.0.0:5432/db" validate:"required,url"`
	Debug       bool   `default:"true"`
}

loader := NewLoader(&Config{}, ConfigFile("termite"))
config, err := loader.Load()
if err != nil {
	panic(err)
}

fmt.Printf("DatabaseURL: %v, Debug: %v", config.DatabaseURL, config.Debug)

Output:

DatabaseURL: postgres://0.0.0.0:5432/db, Debug: true

func NewLoader

func NewLoader[C any](config C, path string) *Loader[C]

NewLoader returns a new Loader.

func (*Loader[C]) Load

func (l *Loader[C]) Load() (C, error)

Load reads the config file at Path into the Config struct and returns it. Subsequent calls will bypass the read and just return the cached struct.

func (*Loader[C]) Reload

func (l *Loader[C]) Reload() (C, error)

Reload forces a reread of the config file at Path.