cliconfig

Documentation

Index

• Variables
• func Load(c *cli.Context, cfg interface{}) error
• func NormalizeFilePath(path string) string
• type File
  • func (f File) AbsolutePath() string
  • func (f File) Exists() bool
  • func (f *File) Load() error
• type Loader
  • func (l Loader) Errorf(format string, v ...interface{}) error
  • func (l *Loader) Load() error

Variables

var CLISpecialNameRegex = regexp.MustCompile(`(arg):(\d+)`)

Functions

func Load

func Load(c *cli.Context, cfg interface{}) error

A shortcut for loading a config from the CLI

func NormalizeFilePath

func NormalizeFilePath(path string) string

Replaces ~/ with the users home directory, ./ with the woring directory, and replaces any parses any environment variables.

Types

type File

type File struct {
	// The path to the file
	Path string

	// A map of key/values that was loaded from the file
	Config map[string]string
}

func (File) AbsolutePath

func (f File) AbsolutePath() string

func (File) Exists

func (f File) Exists() bool

func (*File) Load

func (f *File) Load() error

type Loader

type Loader struct {
	// The context that is passed when using a codegangsta/cli action
	CLI *cli.Context

	// The struct that the config values will be loaded into
	Config interface{}

	// A slice of paths to files that should be used as config files
	DefaultConfigFilePaths []string

	// The file that was used when loading this configuration
	File *File
}

func (Loader) Errorf

func (l Loader) Errorf(format string, v ...interface{}) error

func (*Loader) Load

func (l *Loader) Load() error

Loads the config from the CLI and config files that are present.