uconfig

README

uConfig

This is a slightly altered version of the https://github.com/omeid/uconfig/.

All credits for this module should go to the original creator.

Changes made in this package:

• Removed go.mod and go.sum files;
• Renamed packages;
• Removed examples directory;
• Changed github.com/google/go-cmp/cmp to github.com/stretchr/testify to reduce dependencies;
• Added a formatted usage output to print the configuration in more useful formats for easy copy and pasting;

Documentation

Overview

Package uconfig provides advanced command line flags supporting defaults, env vars, and config structs.

Index

• Variables
• func Must(conf interface{}, plugins ...plugins.Plugin)
• type Config
  • func Classic(conf interface{}, files Files, userPlugins ...plugins.Plugin) (Config, error)
  • func New(conf interface{}, ps ...plugins.Plugin) (Config, error)
• type Files

Variables

var ErrUsage = plugins.ErrUsage

var UsageOutput io.Writer = os.Stdout

UsageOutput is the io.Writer used by Usage message printer.

Functions

func Must

func Must(conf interface{}, plugins ...plugins.Plugin)

Must is like New but also calls Parse and panics instead of returning errors. This is useful in tests.

Types

type Config

type Config interface {
	// Parse will call the parse method of all the added pluginss in the order
	// that the pluginss were registered, it will return early as soon as any
	// plugins fails.
	// You must call this before using the config value.
	Parse() error

	// Usage provides a simple usage message based on the meta data registered
	// by the pluginss.
	Usage()

	// FormattedUsage provides the config used in a desired format: env, yaml or json
	FormattedUsage(format string)
}

Config is the config manager.

func Classic

func Classic(conf interface{}, files Files, userPlugins ...plugins.Plugin) (Config, error)

Classic creates a uconfig manager with defaults,environment variables, and flags (in that order) and optionally file loaders based on the provided Files map and parses them right away.

func New

func New(conf interface{}, ps ...plugins.Plugin) (Config, error)

New returns a new Config. The conf must be a pointer to a struct.

type Files

type Files = file.Files

Files represents a set of file paths and the appropriate unmarshaller function.