config

Documentation

Index

• type GlobalConfig
  • func GlobalConfigFromViper(v *viper.Viper) (*GlobalConfig, error)
  • func NewGlobalConfig(author string, filename string, scripts map[string]string) *GlobalConfig
  • func (c *GlobalConfig) GetTemplatesPath() string
• type ProjectConfig
  • func NewProjectConfig(name string, version string, description string, author string, ...) *ProjectConfig
  • func ParseMergeProjectConfigFile(globalConfig *GlobalConfig) (*ProjectConfig, error)
  • func ParseProjectConfigFile(filePath string) (*ProjectConfig, error)
  • func (projectConfig *ProjectConfig) MergeGlobalConfig(globalConfig *GlobalConfig) *ProjectConfig
  • func (projectConfig *ProjectConfig) RunScript(scriptName string) error
  • func (projectConfig *ProjectConfig) RunScriptArgs(scriptName string, arguments []string) error
  • func (projectConfig *ProjectConfig) WriteToFile(filePath string) error

Types

type GlobalConfig

type GlobalConfig struct {
	Author        string            `json:"author"`
	FileName      string            `json:"filename"`
	TemplatesPath string            `json:"templates_path" mapstructure:"templates_path"`
	Scripts       map[string]string `json:"scripts"`

	// Keep track of where the config file was found
	// Important since can be set through environment variables
	ConfigPath string
}

func GlobalConfigFromViper

func GlobalConfigFromViper(v *viper.Viper) (*GlobalConfig, error)

func NewGlobalConfig

func NewGlobalConfig(author string, filename string, scripts map[string]string) *GlobalConfig

func (*GlobalConfig) GetTemplatesPath

func (c *GlobalConfig) GetTemplatesPath() string

type ProjectConfig

type ProjectConfig struct {
	Name        string            `json:"name"`
	Version     string            `json:"version"`
	Description string            `json:"description"`
	Author      string            `json:"author"`
	Scripts     map[string]string `json:"scripts"`
}

func NewProjectConfig

func NewProjectConfig(name string, version string, description string, author string, scripts map[string]string) *ProjectConfig

func ParseMergeProjectConfigFile

func ParseMergeProjectConfigFile(globalConfig *GlobalConfig) (*ProjectConfig, error)

func ParseProjectConfigFile

func ParseProjectConfigFile(filePath string) (*ProjectConfig, error)

func (*ProjectConfig) MergeGlobalConfig

func (projectConfig *ProjectConfig) MergeGlobalConfig(globalConfig *GlobalConfig) *ProjectConfig

func (*ProjectConfig) RunScript

func (projectConfig *ProjectConfig) RunScript(scriptName string) error

func (*ProjectConfig) RunScriptArgs

func (projectConfig *ProjectConfig) RunScriptArgs(scriptName string, arguments []string) error

func (*ProjectConfig) WriteToFile

func (projectConfig *ProjectConfig) WriteToFile(filePath string) error