config

Documentation

Index

• func LoadDefaultConfig(v *viper.Viper) error
• func LoadUserConfig() (*viper.Viper, error)
• func LoadUserConfigFromFile(v *viper.Viper) error
• type AppConfig
  • func NewAppConfig(name, version, commit, date string, debuggingFlag *bool) (*AppConfig, error)
  • func (c *AppConfig) GetBuildDate() string
  • func (c *AppConfig) GetCommit() string
  • func (c *AppConfig) GetDebug() bool
  • func (c *AppConfig) GetName() string
  • func (c *AppConfig) GetUserConfig() *viper.Viper
  • func (c *AppConfig) GetVersion() string
  • func (c *AppConfig) InsertToUserConfig(key, value string) error
• type AppConfigurer

Functions

func LoadDefaultConfig

func LoadDefaultConfig(v *viper.Viper) error

LoadDefaultConfig loads in the defaults defined in this file

func LoadUserConfig

func LoadUserConfig() (*viper.Viper, error)

LoadUserConfig gets the user's config

func LoadUserConfigFromFile

func LoadUserConfigFromFile(v *viper.Viper) error

LoadUserConfigFromFile Loads the user config from their config file, creating the file as an empty config if it does not exist

Types

type AppConfig

type AppConfig struct {
	Debug      bool   `long:"debug" env:"DEBUG" default:"false"`
	Version    string `long:"version" env:"VERSION" default:"unversioned"`
	Commit     string `long:"commit" env:"COMMIT"`
	BuildDate  string `long:"build-date" env:"BUILD_DATE"`
	Name       string `long:"name" env:"NAME" default:"lazygit"`
	UserConfig *viper.Viper
}

AppConfig contains the base configuration fields required for lazygit.

func NewAppConfig

func NewAppConfig(name, version, commit, date string, debuggingFlag *bool) (*AppConfig, error)

NewAppConfig makes a new app config

func (*AppConfig) GetBuildDate

func (c *AppConfig) GetBuildDate() string

GetBuildDate returns debug flag

func (*AppConfig) GetCommit

func (c *AppConfig) GetCommit() string

GetCommit returns debug flag

func (*AppConfig) GetDebug

func (c *AppConfig) GetDebug() bool

GetDebug returns debug flag

func (*AppConfig) GetName

func (c *AppConfig) GetName() string

GetName returns debug flag

func (*AppConfig) GetUserConfig

func (c *AppConfig) GetUserConfig() *viper.Viper

GetUserConfig returns the user config

func (*AppConfig) GetVersion

func (c *AppConfig) GetVersion() string

GetVersion returns debug flag

func (*AppConfig) InsertToUserConfig

func (c *AppConfig) InsertToUserConfig(key, value string) error

InsertToUserConfig adds a key/value pair to the user's config and saves it

type AppConfigurer

type AppConfigurer interface {
	GetDebug() bool
	GetVersion() string
	GetCommit() string
	GetBuildDate() string
	GetName() string
	GetUserConfig() *viper.Viper
	InsertToUserConfig(string, string) error
}

AppConfigurer interface allows individual app config structs to inherit Fields from AppConfig and still be used by lazygit.