config

Documentation

Index

• Constants
• Variables
• func GetGolangspellHome() string
• func GetHomeDir() string
• func GetModuleName(currentPath string) string
• type Config

Constants

const (

	//Version string.
	Version = major + "." + minor + "." + patch
)

Variables

var (
	Values Config
	// Used for flags.
	CfgFile     string
	UserLicense string
	Author      string
	//DefautConfigFile holds the Golangspell's config file path
	DefautConfigFile string = ConfigFilePath
)

Values stores the current configuration values

var ConfigFilePath = fmt.Sprintf("%s%s%s", GetGolangspellHome(), PlatformSeparator, configFileName)

ConfigFilePath contains the path of the config file

var PlatformIsWindows = getPlatformIsWindows()

PlatformIsWindows checks if the application is running on Windows

var PlatformSeparator = getPlatformSeparator()

PlatformSeparator specific for the current platform

Functions

func GetGolangspellHome

func GetGolangspellHome() string

GetGolangspellHome - platform agnostic

func GetHomeDir

func GetHomeDir() string

GetHomeDir provides the User's Home Directory

func GetModuleName

func GetModuleName(currentPath string) string

GetModuleName from the current application based in the go.mod file

Types

type Config

type Config struct {
	//LogLevel - DEBUG or INFO or WARNING or ERROR or PANIC or FATAL
	LogLevel string
	//TestRun state if the current execution is a test execution
	TestRun bool
	//GoPath contains the configured or by convention GOPATH
	GoPath string
}

Config contains the application's configuration values. Add here your own variables and bind it on init() function