config

package

v0.7.3 Latest Latest Go to latest Published: Nov 13, 2023 License: MIT-0 Imports: 10 Imported by: 0

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 config implements the Config structure, and holds related functions.

View Source

const Debug = false

Debug is true for debug builds.

This section is empty.

This section is empty.

type Config struct {
	LyricsDir string
	MusicDir  string

	MPD struct {
		Address    string
		Connection string
		Password   string
	}
}

Config holds the configuration.

func DefaultConfig() (cfg *Config)

DefaultConfig returns the default configuration.

func (cfg *Config) Assert() error

Assert return error if cfg is invalid.

func (cfg *Config) Expand()

Expand expands tilde ("~") and variables ("$VAR" or "${VAR}") in paths in cfg. Sets LyricsDir to MusicDir if empty.

func (cfg *Config) FromClient(c client.Client)

FromClient merges the configuration from client.

func (cfg *Config) FromEnv(env func(string) string)

FromEnv merges the configuration from env.

func (cfg *Config) FromFile(fpath string) error

FromFile merges the configuration from fpath.

func (cfg *Config) FromFiles(files []string) error

FromFiles merges the configuration fore files.

func (cfg *Config) FromOpts(opts docopt.Opts)

FromOpts merges the configuration from docopt.Opts opts.

func (cfg *Config) String() string