config

Documentation

Overview

Package config gomodoro configuration

Index

• Constants
• type Config
  • func GetConfig() (*Config, error)
  • func (c *Config) ExpandLogFile() (string, error)
  • func (c *Config) ExpandTaskFile() (string, error)
  • func (c *Config) ExpandUnixDomainSocketPath() (string, error)
• type PomodoroConfig
• type TogglConfig
  • func (tc TogglConfig) Enable() bool

Constants

const (
	// DefaultWorkSec default working second
	DefaultWorkSec = 1500
	// DefaultShortBreakSec default short break second
	DefaultShortBreakSec = 300
	// DefaultLongBreakSec default long break second
	DefaultLongBreakSec = 900

	// DefaultLogFile default log file path
	DefaultLogFile = "~/.gomodoro/gomodoro.log"
	// DefaultTaskFile default task file path
	DefaultTaskFile = "~/.gomodoro/tasks.yaml"
	// DefaultUnixDomainScoketPath default unix domain socket file path
	DefaultUnixDomainScoketPath = "~/.gomodoro/gomodoro.sock"
)

Types

type Config

type Config struct {
	Pomodoro             PomodoroConfig `mapstructure:"pomodoro"`
	Toggl                TogglConfig    `mapstructure:"toggl"`
	LogFile              string         `mapstructure:"log_file"`
	TaskFile             string         `mapstructure:"task_file"`
	UnixDomainScoketPath string         `mapstructure:"unix_domain_socket_path"`
}

Config config for gomodoro

func GetConfig

func GetConfig() (*Config, error)

GetConfig get Config

func (*Config) ExpandLogFile

func (c *Config) ExpandLogFile() (string, error)

ExpandLogFile get expand log file

func (*Config) ExpandTaskFile

func (c *Config) ExpandTaskFile() (string, error)

ExpandTaskFile get expand task file

func (*Config) ExpandUnixDomainSocketPath

func (c *Config) ExpandUnixDomainSocketPath() (string, error)

ExpandUnixDomainSocketPath get expand UnixDomainScoketPath

type PomodoroConfig

type PomodoroConfig struct {
	WorkSec       int `mapstructure:"work_sec" validate:"gt=0,lte=3600"`
	ShortBreakSec int `mapstructure:"short_break_sec" validate:"gt=0,lte=3600"`
	LongBreakSec  int `mapstructure:"long_break_sec" validate:"gt=0,lte=3600"`
}

PomodoroConfig config for pomodoro

type TogglConfig

type TogglConfig struct {
	APIToken  string `mapstructure:"api_token"`
	ProjectID int    `mapstructure:"project_id"`
}

TogglConfig config for Toggl

func (TogglConfig) Enable

func (tc TogglConfig) Enable() bool

Enable confirm toggl client is enable