config

Documentation

Index

• Variables
• func GetVerboseLoggingFlag() bool
• func ParseCLI()
• type Config
  • func New(globalConfig *GlobalConfig, projectDefinition *ProjectConfig, ...) *Config
• type GlobalConfig
  • func ParseGlobalConfig(configFile string) *GlobalConfig
• type ProjectConfig

Variables

var (
	ConfigFile = kingpin.Flag("configFile", "Configuration File").Short('c').String() // TODO make it mandatory or have a sane default
	Verbose    = kingpin.Flag("verbose", "Verbose mode.").Short('v').Bool()
)

Functions

func GetVerboseLoggingFlag

func GetVerboseLoggingFlag() bool

func ParseCLI

func ParseCLI()

Types

type Config

type Config struct {
	ProjectDir        string
	ProjectName       string
	ScoDir            string
	ScoConfigFile     string
	VerboseOutput     bool
	Logger            *log_.Logger
	GitIgnore         *gitignore.GitIgnore // TODO rename into something git agnostiv like FileIgnore
	ScoDirPermissions os.FileMode
}

func New

func New(globalConfig *GlobalConfig, projectDefinition *ProjectConfig, logger *log_.Logger) *Config

type GlobalConfig

type GlobalConfig struct {
	Projects       []ProjectConfig `json:"projects"`
	IgnorePatterns []string        `json:"ignorePatterns"`
}

func ParseGlobalConfig

func ParseGlobalConfig(configFile string) *GlobalConfig

type ProjectConfig

type ProjectConfig struct {
	Name        string   `json:"name"`
	Path        string   `json:"path"`
	IgnoreFiles []string `json:"ignoreFiles"`
	ScoDir      string   `json:"scoDir"`
}