config

Documentation

Index

• func GetConfigFilePath(file string) (string, error)
• type Config
  • func LoadConfig() *Config
• type SubstitutePathRule
• type SubstitutePathRules

Functions

func GetConfigFilePath

func GetConfigFilePath(file string) (string, error)

GetConfigFilePath gets the full path to the given config file name.

Types

type Config

type Config struct {
	// Commands aliases.
	Aliases map[string][]string
	// Source code path substitution rules.
	SubstitutePath SubstitutePathRules `yaml:"substitute-path"`
}

Config defines all configuration options available to be set through the config file.

func LoadConfig

func LoadConfig() *Config

LoadConfig attempts to populate a Config object from the config.yml file.

type SubstitutePathRule

type SubstitutePathRule struct {
	// Directory path will be substituted if it matches `From`.
	From string
	// Path to which substitution is performed.
	To string
}

Describes a rule for substitution of path to source code file.

type SubstitutePathRules

type SubstitutePathRules []SubstitutePathRule

Slice of source code path substitution rules.