plugins

package

v0.7.0 Latest Latest Go to latest Published: Mar 14, 2024 License: MIT Imports: 4 Imported by: 9

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package plugins describes the uconfig provider interface. it exists to enable uconfig.Classic without circular deps.

This section is empty.

View Source

var ErrUsage = errors.New("uconfig: usage request")

ErrUsage is returned when user has request usage message via some plugin, mostly flags.

func RegisterTag(name string)

RegisterTag allows providers to ensure their tag is unique. they must call this function from an init.

type Plugin interface {
	Parse() error
}

Plugin is the common interface for all uConfig providers.

type Visitor interface {
	Plugin

	Visit(flat.Fields) error
}

Visitor is the interface for providers that require a flat view of the config, like flags, env vars

type Walker interface {
	Plugin

	Walk(interface{}) error
}

Walker is the interface for providers that take the whole config, like file loaders.

Path	Synopsis
defaults Package defaults provides flags support for uconfig	Package defaults provides flags support for uconfig
env Package env provides environment variables support for uconfig	Package env provides environment variables support for uconfig
file Package file provides config file support for uconfig	Package file provides config file support for uconfig
flag Package flag provides flags support for uconfig	Package flag provides flags support for uconfig
secret Package secret enable uconfig to integrate with secret plugins.	Package secret enable uconfig to integrate with secret plugins.