config

README

config (v1.0.0)

Installation:

go get -u github.com/bsdlp/config

Usage:

import "github.com/bsdlp/config"

Documentation

Overview

Package config version v1.0.0

Index

• Constants
• Variables
• func ExpandUser(path string) (exPath string)
• type Config
  • func (c Config) EnvVar() (envvar string)
  • func (c Config) Load(dst interface{}) (err error)
  • func (c Config) Path() (path string)
• type FileFormat
• type Unmarshaller

Constants

const (
	UserBase   string = "~/.config/"
	SystemBase string = "/etc/"
)

UserBase and SystemBase are the prefixes for the user and system config paths, respectively.

Variables

var (
	// ErrNilUnmarshaller is returned when an undefined unmarshaller is passed to
	// load()
	ErrNilUnmarshaller = errors.New("config: nil unmarshaller")

	// ErrNilFileFormat is returned when the config struct contains a nil FileFormat
	ErrNilFileFormat = errors.New("config: file format undefined")

	// ErrConfigFileNotFound is returned when config files at $HOME/:organization/:system/config.{extension}
	// or /etc/:organization/:systems/config.{extension} are missing
	ErrConfigFileNotFound = errors.New("config: missing config files")

	// ErrNotAPointer is returned when a non-pointer is passed into load
	ErrNotAPointer = errors.New("config: not a pointer")
)

Functions

func ExpandUser

func ExpandUser(path string) (exPath string)

ExpandUser acts kind of like os.path.expanduser in Python, except only supports expanding "~/" or "$HOME"

Types

type Config

type Config struct {
	// optional additional namespace for orgs.
	Organization string

	// Name of the service associated with this config.
	Service string

	// describes the type of config file to unmarshal
	FileFormat *FileFormat
	// contains filtered or unexported fields
}

Config implements Loader

func (Config) EnvVar

func (c Config) EnvVar() (envvar string)

EnvVar returns the name of the environment variable containing the URI of the config. Example: PODHUB_UUIDD_CONFIG_URI

func (Config) Load

func (c Config) Load(dst interface{}) (err error)

Load is a convenience function registered to config.Namespace to implement Config.Load().

func (Config) Path

func (c Config) Path() (path string)

Path returns path to config, chosen by hierarchy and checked for existence:

1. {ORGANIZATION}_{SERVICE}_CONFIG_URI environment variable

2. User config (~/.config/podhub/canary/config.{extension})

3. System config (/etc/podhub/canary/config.{extension})

type FileFormat

type FileFormat struct {
	// file extension, i.e. "yaml" for a file named "config.yaml"
	Extension string

	// Unmarshaller used to unmarshal config data
	Unmarshaller Unmarshaller
}

FileFormat is the type of config file to unmarshal

type Unmarshaller

type Unmarshaller func(data []byte, v interface{}) error

Unmarshaller defines the function signature for unmarshal functions