Module pomodoro

Expand description

§Technique

There are six steps in the original technique:

Decide on the task to be done.
Set the pomodoro timer (traditionally to 25 minutes).
Work on the task.
End work when the timer rings and put a checkmark on a piece of paper.
If you have fewer than four checkmarks, take a short break (3–5 minutes) and then return to step 2.
After four pomodoros, take a longer break (15–30 minutes), reset your checkmark count to zero, then go to step 1.

Key	Values	Default
`format`	The format used when in idle, prompt, or notify states	`" $icon{ $message\|} "`
`pomodoro_format`	The format used when the pomodoro is running or paused	`" $icon $status_icon{ $completed_pomodoros.tally()\|} $time_remaining.duration(hms:true) "`
`break_format`	The format used when the pomodoro is during the break	`" $icon $status_icon Break: $time_remaining.duration(hms:true) "`
`message`	Message when timer expires	`"Pomodoro over! Take a break!"`
`break_message`	Message when break is over	`"Break over! Time to work!"`
`notify_cmd`	A shell command to run as a notifier. `{msg}` will be substituted with either `message` or `break_message`.	`None`
`blocking_cmd`	Is `notify_cmd` blocking? If it is, then pomodoro block will wait until the command finishes before proceeding. Otherwise, you will have to click on the block in order to proceed.	`false`

Placeholder	Value	Type	Supported by
`icon`	A static icon	Icon	All formats
`status_icon`	An icon that reflects the pomodoro state	Icon	`pomodoro_format`, `break_format`
`message`	Current message	Text	`format`
`time_remaining`	How much time is left (minutes)	Duration	`pomodoro_format`, `break_format`
`completed_pomodoros`	The number of completed pomodoros	Number	`pomodoro_format`

Use swaynag as a notifier:

[[block]]
block = "pomodoro"
notify_cmd = "swaynag -m '{msg}'"
blocking_cmd = true

Use notify-send as a notifier:

[[block]]
block = "pomodoro"
notify_cmd = "notify-send '{msg}'"
blocking_cmd = false