config

package
v1.0.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 6, 2017 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL