config

Documentation

Index

• Variables
• func ExpandString(str string) string
• func GetSetting(str string) string
• func GetVariable(str string) string
• func VariableExists(str string) bool
• type Config
  • func LoadConfig(bytes []byte) *Config
  • func (c *Config) ExpandString(str string) string
  • func (c *Config) GetSetting(name string) string
  • func (c *Config) GetVariable(path string) string
  • func (c *Config) SetVariable(path, value string)
  • func (c *Config) SettingExists(name string) bool
  • func (c *Config) String() string
  • func (c *Config) VariableExists(path string) bool
  • func (c *Config) Write()

Variables

var GlobalConfig = loadConfigFile("config.json")

GlobalConfig - The global configuration read from config.json

var InMemory = false

InMemory - When true the config will not write to the disk. This is used for testing.

var LocalConfig = loadConfigFile("config.local.json")

LocalConfig - The local configuration read from config.local.json

var ProjectPath = "."

The path to the project root

var TempConfig = loadDefaultConfig()

TempConfig - A temporary config object that persists only for the current session.

Functions

func ExpandString

func ExpandString(str string) string

ExpandString - Given a string with a variable inside it. The string will be expanded and the variable placeholders replaced with variables from either config. Priority goes to the local config.

func GetSetting

func GetSetting(str string) string

GetSetting - Returns the value of a variable from either config. Priority goes to the local config.

func GetVariable

func GetVariable(str string) string

GetVariable - Returns the value of a variable from either config. Priority goes to the local config.

func VariableExists

func VariableExists(str string) bool

VariableExists - Checks if a variable exists in either config.

Types

type Config

type Config struct {
	Filename string
	// contains filtered or unexported fields
}

Config - The config object is used to store the application configuration. The package attempts instantiate two configs one for the local config and one for the global config.

func LoadConfig

func LoadConfig(bytes []byte) *Config

Loads a config from a byte array.

func (*Config) ExpandString

func (c *Config) ExpandString(str string) string

ExpandString - Given a string with a variable inside it. The string will be expanded and the variable placeholders replaced with variables from the config.

func (*Config) GetSetting

func (c *Config) GetSetting(name string) string

GetSetting - Returns a setting as a string from the path specified in the config.

func (*Config) GetVariable

func (c *Config) GetVariable(path string) string

GetVariable returns a saved variable from the config.

func (*Config) SetVariable

func (c *Config) SetVariable(path, value string)

SetVariable - sets a variable in the config.

func (*Config) SettingExists

func (c *Config) SettingExists(name string) bool

SettingExists - returns true if a setting is specified in the config.

func (*Config) String

func (c *Config) String() string

String - returns the config JSON as a string.

func (*Config) VariableExists

func (c *Config) VariableExists(path string) bool

VariableExists - Checks to see if a variable exists at the path specified.

func (*Config) Write

func (c *Config) Write()

Write - writes the config to the disk. Uses the path specified in the Filename property.