config

Documentation

Overview

Package config loads, stores, and provides default values for work and break tasks.

Index

• Constants
• Variables
• func LoadConfig() error
• func Setup()
• type ASCIIArt
• type Config
• type LongBreak
• type Notification
• type Task
• type TaskType
  • func (t TaskType) GetTask() *Task
  • func (t TaskType) Opposite() TaskType
  • func (t TaskType) String() string

Constants

const (
	AppName    = "pomo"
	ConfigFile = "pomo.yaml"
)

Variables

var (
	//go:embed pomo.png
	Icon []byte
	C    Config

	DefaultConfig = map[string]any{
		"onSessionEnd": "ask",
		"asciiArt": map[string]any{
			"enabled": true,
			"font":    ascii.DefaultFont,
			"color":   colors.TimerFg,
		},
		"work": map[string]any{
			"duration": 25 * time.Minute,
			"title":    "work session",
			"notification": map[string]any{
				"enabled": true,
				"urgent":  false,
				"title":   "work finished 🎉",
				"message": "time to take a break!",
			},
		},
		"break": map[string]any{
			"duration": 5 * time.Minute,
			"title":    "break session",
			"notification": map[string]any{
				"enabled": true,
				"urgent":  false,
				"title":   "break over 😴",
				"message": "back to work!",
			},
		},
		"longBreak": map[string]any{
			"enabled":  true,
			"after":    4,
			"duration": 15 * time.Minute,
		},
	}
)

Functions

func LoadConfig

func LoadConfig() error

func Setup

func Setup()

Types

type ASCIIArt

type ASCIIArt struct {
	Enabled bool
	Font    string
	Color   string
}

type Config

type Config struct {
	OnSessionEnd string
	ASCIIArt     ASCIIArt
	Work         Task
	Break        Task
	LongBreak    LongBreak
}

type LongBreak

type LongBreak struct {
	Enabled  bool
	After    int
	Duration time.Duration
}

type Notification

type Notification struct {
	Enabled bool
	Urgent  bool
	Title   string
	Message string
	Icon    string
}

type Task

type Task struct {
	Title        string
	Duration     time.Duration
	Then         [][]string
	Notification Notification
}

type TaskType

type TaskType int

const (
	WorkTask TaskType = iota
	BreakTask
)

func (TaskType) GetTask

func (t TaskType) GetTask() *Task

func (TaskType) Opposite

func (t TaskType) Opposite() TaskType

func (TaskType) String

func (t TaskType) String() string