cfg

README

Configuration loader for Go applications

Install

go get github.com/goburrow/cfg

Example

• example.go

package main

import (
	"fmt"

	"github.com/goburrow/cfg"
)

func main() {
	keys := make(map[string]string)

	// DefaultLoader loads configuration from ini file "~/.config/myApp/config"
	// if it exists and environment variables starting with "myApp_".
	loader := cfg.DefaultLoader("myApp")
	err := loader.Load(keys)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(keys)
}

• ~/.config/myApp/config

x = 0
y = 0

[point1]
x = 1
y = 2

• Run:

$ env myApp_y=1 myApp_point1.x=3 ./example
map[x:0 y:1 point1.x:3 point1.y:2]

Documentation

Overview

Package cfg provides configuration file loaders for Go applications.

Index

• func UserConfigPath(appName, fileName string) string
• type Loader
  • func DefaultLoader(appName string) Loader
  • func NewOverridingChain(l ...Loader) Loader

Functions

func UserConfigPath

func UserConfigPath(appName, fileName string) string

UserConfigPath returns ~/.config/appName/fileName.

Types

type Loader

type Loader interface {
	Load(map[string]string) error
}

Loader is the configuration loader.

func DefaultLoader

func DefaultLoader(appName string) Loader

DefaultLoader returns a chain of loading ini files from: 1. ~/.config/appName/config 2. System environments variable with appName_ prefix

func NewOverridingChain

func NewOverridingChain(l ...Loader) Loader

NewOverridingChain returns a Loader which loads all configurations in the chain. Keys in later chain will override the same key from previous chain.