ini

package

v1.90.0 Latest Latest Go to latest Published: Feb 7, 2024 License: BSD-3-Clause Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wakatime/wakatime-cli

Links

Open Source Insights

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 ¶

View Source

const (

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

Variables ¶

This section is empty.

Functions ¶

func FilePath ¶ added in v1.30.3

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

FilePath returns the path for wakatime config file.

func ImportFilePath ¶ added in v1.42.1

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

ImportFilePath returns the path for import wakatime config file.

func InternalFilePath ¶ added in v1.30.3

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

InternalFilePath returns the path for the wakatime internal config file.

func ReadInConfig ¶ added in v1.30.3

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

ReadInConfig reads wakatime config file in memory.

func WakaResourcesDir ¶ added in v1.73.0

func WakaResourcesDir() (string, error)

WakaResourcesDir returns the ~/.wakatime/ folder.

Types ¶

type WakaHomeType ¶ added in v1.73.0

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 ¶ added in v1.30.3

func WakaHomeDir() (string, WakaHomeType, error)

WakaHomeDir returns the current user's home directory.

type Writer ¶ added in v1.30.3

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

Writer defines the methods to write to config file.

type WriterConfig ¶ added in v1.30.3

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

WriterConfig stores the configuration necessary to write to config file.

func NewWriter ¶ added in v1.45.1

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

NewWriter creates a new writer instance.

func (*WriterConfig) Write ¶ added in v1.30.3

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

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

Source Files ¶

View all Source files

ini.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL