README
¶
Opinionated configuration management for Go tools
Documentation
¶
Overview ¶
Package conf provides a high-level abstraction over methods to manage user configuration stored under $XDG_CONFIG_DIR. Being opinionated, all configuration is written and read in YAML.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type C ¶
type C struct{}
C encompasses various methods to read, write and query config file.
func New ¶
func New() *C
New creates a new instance of C. It is mandatory to run the Init() method immediately after.
func (*C) Init ¶
Init creates the necessary config directory and file (if absent). It is mandatory to call this method before performing any operations.
func (*C) MustInit ¶
func (c *C) MustInit()
MustInit is same as Init but exits the program in case of an error.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
util
Package util provides reusable helper function.
|
Package util provides reusable helper function. |
|
Package vars provides a high-level abstraction over an internal concurrency safe map object and operations like Get, Set, Del & Exists for management of temporary local cache.
|
Package vars provides a high-level abstraction over an internal concurrency safe map object and operations like Get, Set, Del & Exists for management of temporary local cache. |
Click to show internal directories.
Click to hide internal directories.