config

Documentation

Index

• func GetConfigFilePath(file string) (string, error)
• func SaveConfig(conf *Config) error
• func SplitQuotedFields(in string, quote rune) []string
• 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.

func SaveConfig

func SaveConfig(conf *Config) error

func SplitQuotedFields

func SplitQuotedFields(in string, quote rune) []string

Like strings.Fields but ignores spaces inside areas surrounded by the specified quote character. To specify a single quote use backslash to escape it: '\”

Types

type Config

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

	// MaxStringLen is the maximum string length that the commands print,
	// locals, args and vars should read (in verbose mode).
	MaxStringLen *int `yaml:"max-string-len,omitempty"`
	// MaxArrayValues is the maximum number of array items that the commands
	// print, locals, args and vars should read (in verbose mode).
	MaxArrayValues *int `yaml:"max-array-values,omitempty"`

	// If ShowLocationExpr is true whatis will print the DWARF location
	// expression for its argument.
	ShowLocationExpr bool `yaml:"show-location-expr"`
}

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.