config

Documentation

Index

• func GetDefaultConfig() []byte
• func GetPlatformDefaultConfig() []byte
• func LoadAndMergeFile(v *viper.Viper, filename string) error
• func LoadConfig(filename string, withDefaults bool) (*viper.Viper, error)
• func LoadDefaults(v *viper.Viper, defaults []byte) error
• type AppConfig
  • func NewAppConfig(name, version, commit, date string, buildSource string, debuggingFlag bool) (*AppConfig, error)
  • func (c *AppConfig) GetAppState() *AppState
  • func (c *AppConfig) GetBuildDate() string
  • func (c *AppConfig) GetBuildSource() string
  • func (c *AppConfig) GetCommit() string
  • func (c *AppConfig) GetDebug() bool
  • func (c *AppConfig) GetIsNewRepo() bool
  • func (c *AppConfig) GetName() string
  • func (c *AppConfig) GetUserConfig() *viper.Viper
  • func (c *AppConfig) GetVersion() string
  • func (c *AppConfig) LoadAppState() error
  • func (c *AppConfig) SaveAppState() error
  • func (c *AppConfig) SetIsNewRepo(toSet bool)
  • func (c *AppConfig) WriteToUserConfig(key, value string) error
• type AppConfigurer
• type AppState

Functions

func GetDefaultConfig

func GetDefaultConfig() []byte

GetDefaultConfig returns the application default configuration

func GetPlatformDefaultConfig

func GetPlatformDefaultConfig() []byte

GetPlatformDefaultConfig gets the defaults for the platform

func LoadAndMergeFile

func LoadAndMergeFile(v *viper.Viper, filename string) error

LoadAndMergeFile Loads the config/state file, creating the file has an empty one if it does not exist

func LoadConfig

func LoadConfig(filename string, withDefaults bool) (*viper.Viper, error)

LoadConfig gets the user's config

func LoadDefaults

func LoadDefaults(v *viper.Viper, defaults []byte) error

LoadDefaults loads in the defaults defined in this file

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"`
	BuildSource string `long:"build-source" env:"BUILD_SOURCE" default:""`
	UserConfig  *viper.Viper
	AppState    *AppState
	IsNewRepo   bool
}

AppConfig contains the base configuration fields required for lazygit.

func NewAppConfig

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

NewAppConfig makes a new app config

func (*AppConfig) GetAppState

func (c *AppConfig) GetAppState() *AppState

GetAppState returns the app state

func (*AppConfig) GetBuildDate

func (c *AppConfig) GetBuildDate() string

GetBuildDate returns debug flag

func (*AppConfig) GetBuildSource

func (c *AppConfig) GetBuildSource() string

GetBuildSource returns the source of the build. For builds from goreleaser this will be binaryBuild

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) GetIsNewRepo

func (c *AppConfig) GetIsNewRepo() bool

GetIsNewRepo returns known repo boolean

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) LoadAppState

func (c *AppConfig) LoadAppState() error

LoadAppState loads recorded AppState from file

func (*AppConfig) SaveAppState

func (c *AppConfig) SaveAppState() error

SaveAppState marhsalls the AppState struct and writes it to the disk

func (*AppConfig) SetIsNewRepo

func (c *AppConfig) SetIsNewRepo(toSet bool)

SetIsNewRepo set if the current repo is known

func (*AppConfig) WriteToUserConfig

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

WriteToUserConfig 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
	GetBuildSource() string
	GetUserConfig() *viper.Viper
	GetAppState() *AppState
	WriteToUserConfig(string, string) error
	SaveAppState() error
	LoadAppState() error
	SetIsNewRepo(bool)
	GetIsNewRepo() bool
}

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

type AppState

type AppState struct {
	LastUpdateCheck int64
	RecentRepos     []string
}

AppState stores data between runs of the app like when the last update check was performed and which other repos have been checked out