ini

Documentation

Index

• Constants
• func FilePath(v *viper.Viper) (string, error)
• func ImportFilePath(v *viper.Viper) (string, error)
• func InternalFilePath(v *viper.Viper) (string, error)
• func ReadInConfig(v *viper.Viper, configFilePath string) error
• func WakaResourcesDir() (string, error)
• type WakaHomeType
  • func WakaHomeDir() (string, WakaHomeType, error)
• type Writer
• type WriterConfig
  • func NewWriter(v *viper.Viper, filepathFn func(v *viper.Viper) (string, error)) (*WriterConfig, error)
  • func (w *WriterConfig) Write(section string, keyValue map[string]string) error

Constants

const (

	// DateFormat is the default format for date in config file.
	DateFormat = time.RFC3339
)

Functions

func FilePath

func FilePath(v *viper.Viper) (string, error)

FilePath returns the path for wakatime config file.

func ImportFilePath

func ImportFilePath(v *viper.Viper) (string, error)

ImportFilePath returns the path for import wakatime config file.

func InternalFilePath

func InternalFilePath(v *viper.Viper) (string, error)

InternalFilePath returns the path for the wakatime internal config file.

func ReadInConfig

func ReadInConfig(v *viper.Viper, configFilePath string) error

ReadInConfig reads wakatime config file in memory.

func WakaResourcesDir

func WakaResourcesDir() (string, error)

WakaResourcesDir returns the ~/.wakatime/ folder.

Types

type WakaHomeType

type WakaHomeType int

WakaHomeType is WakaTime home type.

const (

	// WakaHomeTypeUnknown is unknown WakaTime home type.
	WakaHomeTypeUnknown WakaHomeType = iota
	// WakaHomeTypeEnvVar is WakaTime home type from environment variable.
	WakaHomeTypeEnvVar
	// WakaHomeTypeOSDir is WakaTime home type from OS directory.
	WakaHomeTypeOSDir
)

func WakaHomeDir

func WakaHomeDir() (string, WakaHomeType, error)

WakaHomeDir returns the current user's home directory.

type Writer

type Writer interface {
	Write(section string, keyValue map[string]string) error
}

Writer defines the methods to write to config file.

type WriterConfig

type WriterConfig struct {
	ConfigFilepath string
	File           *ini.File
}

WriterConfig stores the configuration necessary to write to config file.

func NewWriter

func NewWriter(v *viper.Viper, filepathFn func(v *viper.Viper) (string, error)) (*WriterConfig, error)

NewWriter creates a new writer instance.

func (*WriterConfig) Write

func (w *WriterConfig) Write(section string, keyValue map[string]string) error

Write persists key(s) and value(s) on disk.