source

Documentation

Index

• Constants
• func Cascade(logWriter io.Writer, shortCircuit bool, sources ...ConfigProvider) *configSource
• func Default() *configSource
• func Environment(key string) *configSource
• func File(configFile string) *configSource
• func XDGBaseDir() *configSource
• type ConfigProvider

Constants

const DefaultHoardConfigFileName = "hoard.conf"

const DefaultJSONConfigEnvironmentVariable = "HOARD_JSON_CONFIG"

const STDINFileIdentifier = "-"

Functions

func Cascade

func Cascade(logWriter io.Writer, shortCircuit bool, sources ...ConfigProvider) *configSource

func Default

func Default() *configSource

func Environment

func Environment(key string) *configSource

Source from a single environment variable with config embedded in JSON

func File

func File(configFile string) *configSource

Source from file

func XDGBaseDir

func XDGBaseDir() *configSource

Try to find config by using XDG base dir spec

Types

type ConfigProvider

type ConfigProvider interface {
	// Description of where this provider sources its config from
	From() string
	// Get the config possibly overriding values passed in from baseConfig
	Get(baseConfig *config.HoardConfig) (*config.HoardConfig, error)
	// Return a copy of the provider that does nothing if skip is true
	SetSkip(skip bool) ConfigProvider
	// Whether to skip this provider
	Skip() bool
}