README
¶
config
This is a support library for groom.
It checks and parses the configuration and provides methods for modifying it.
It is most useful for developing subcommands for groom(https://github.com/golang-groom/groom)
Usage
The library only exposes a few functions ParseConf and AddSubcommand..
Documentation
¶
Overview ¶
Package parses the config (global and user) and provides to the application. It is a support library for the `groom` suite of application.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var GROOM_CONFIG_LOCATIONS []configLocation = []configLocation{ { // contains filtered or unexported fields }, { // contains filtered or unexported fields }, { // contains filtered or unexported fields }, }
Global variable defines the location of the config file to be present. The order of the array determines the order of the config location checking.
Locations for parsing (In order of preference) - /etc/groom/config.toml - $XDG_CONFIG_HOME/.config/config.toml - $HOME/.config/config.toml
Functions ¶
func AddSubcommand ¶
func SyncConfig ¶
func SyncConfig()
Types ¶
type GroomConfig ¶
type GroomConfig struct {
GroomBin string `toml:"groomBin"`
ConfigPath string
Plugins []Plugin `toml:"plugin"`
}
func ParseConf ¶
func ParseConf() *GroomConfig
Function parses the configuration file. If no config found at default locations, return good-enough values.
Source Files
Directories