lib

Documentation

Index

• Variables
• func CheckRequiredArguments(requiredArguments []string, arguments map[string]string)
• func Clone(url string, targetDir string, _refName string, _progress bool) (r *git.Repository)
• func ParseArguments() map[string]string
• func Pull(targetDir string, _refName string, _progress bool) (err error)
• func ReadFile(path string) []byte
• type DependencyConfig
• type ProductConfig
  • func GetProductConfig(configFile string) ProductConfig

Variables

var Catchy = color.New(color.Bold, color.FgCyan).PrintfFunc()

Catchy : bold and cyan text

var DevelopCommands = map[string]string{
	"init":   "Initializes development environment for the given configuration file.",
	"update": "Updates development environment by pulling all dependencies for config",
}

DevelopCommands : commands which target development environments

var Error = color.New(color.Bold, color.FgRed).PrintfFunc()

Error : bold and red text

var Notice = color.New(color.Bold, color.FgBlue).PrintfFunc()

Notice : bold and blue text

var RootCommands = map[string]string{
	"develop": "Run a command which targets development environments (such as init or update)",
}

RootCommands : all available root commands

var Warning = color.New(color.FgYellow).PrintfFunc()

Warning : yellow text

Functions

func CheckRequiredArguments

func CheckRequiredArguments(requiredArguments []string, arguments map[string]string)

CheckRequiredArguments : checks whether all arguments in requiredArguments are available in arguments map and prints errors for missing arguments

func Clone

func Clone(url string, targetDir string, _refName string, _progress bool) (r *git.Repository)

Clone : Clones a given repository into targetDir

func ParseArguments

func ParseArguments() map[string]string

ParseArguments : parses command line flags

func Pull

func Pull(targetDir string, _refName string, _progress bool) (err error)

Pull : Pulls a given repository

func ReadFile

func ReadFile(path string) []byte

ReadFile : reads a file from a given path and returns its contents

Types

type DependencyConfig

type DependencyConfig struct {
	Version    string
	Repository string
	Artifacts  string
}

DependencyConfig : config for dependency

type ProductConfig

type ProductConfig struct {
	Name         string
	Version      string
	Description  string
	Dependencies map[string]*DependencyConfig
}

ProductConfig : config for product

func GetProductConfig

func GetProductConfig(configFile string) ProductConfig

GetProductConfig : receives a bytestring and returns a ProductConfig