Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wthollingsworth/pomodoro.nvim
A Pomodoro timer for Neovim written in Lua
https://github.com/wthollingsworth/pomodoro.nvim
Last synced: 11 days ago
JSON representation
A Pomodoro timer for Neovim written in Lua
- Host: GitHub
- URL: https://github.com/wthollingsworth/pomodoro.nvim
- Owner: wthollingsworth
- License: gpl-3.0
- Created: 2021-07-31T22:49:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T22:26:57.000Z (about 2 months ago)
- Last Synced: 2024-04-29T23:36:33.835Z (about 2 months ago)
- Language: Lua
- Homepage:
- Size: 26.4 KB
- Stars: 34
- Watchers: 1
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - wthollingsworth/pomodoro.nvim - A Pomodoro timer for Neovim written in Lua (Lua)
README
# pomodoro.nvim
A Neovim plugin written (mostly) in Lua that implements the [Pomodoro technique](https://francescocirillo.com/pages/pomodoro-technique).
## Features
When a timer goes off, a menu is displayed to prompt you to take a break (or start the next pomodoro) with the option to stop the Pomodoro session.
When these prompts are displayed, you can also press `b` to take a break (if applicable), `p` to start the next pomodoro (if applicable), or `q` to stop the Pomodoro session.
## Requirements
* Neovim >= 0.5.0
* [A patched font](https://www.nerdfonts.com/)
* [MunifTanjim/nui.nvim](https://github.com/MunifTanjim/nui.nvim)
## Installation
Install the plugin with your preferred package manager.
### [packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
'wthollingsworth/pomodoro.nvim',
requires = 'MunifTanjim/nui.nvim'
}
```
## Configuration
You can configure the length of the pomodoro, the length of a short break, the length of a long break, and the number of pomodoros that must be completed in order to take a longer break. The values shown below are the defaults.
### Lua
```lua
use {
'wthollingsworth/pomodoro.nvim',
requires = 'MunifTanjim/nui.nvim',
config = function()
require('pomodoro').setup({
time_work = 25,
time_break_short = 5,
time_break_long = 20,
timers_to_long_break = 4
})
end
}
```
### Vimscript
```VimL
let g:pomodoro_time_work = 25
let g:pomodoro_time_break_short = 5
let g:pomodoro_time_break_long = 20
let g:pomodoro_timers_to_long_break = 4
```
## Usage
Three Ex commands are provided.
| Command | Description |
|-----------------|-------------------------------------------------------|
| :PomodoroStart | Starts the timer. |
| :PomodoroStatus | Displays the status of the timer in the message area. |
| :PomodoroStop | Stops the Pomodoro session. |
### Showing the timer in the statusline
For [hoob3rt/lualine.nvim](https://github.com/hoob3rt/lualine.nvim), you can do something like:
```lua
require('lualine').setup({
sections = {
lualine_c = { 'filename', require('pomodoro').statusline }
}
})
```
## Alternatives
* [mnick/vim-pomodoro](https://github.com/mnick/vim-pomodoro) and [adelarsq/vim-pomodoro](https://github.com/adelarsq/vim-pomodoro) are Vimscript plugins similar to this one with a few more bells and whistles.
* [rbong/pimodoro](https://github.com/rbong/pimodoro) is a Vimscript plugin similar to this one that encourages you to track your tasks in another file.
* [ukui00a/denops-pomodoro.vim](https://github.com/uki00a/denops-pomodoro.vim) is written in Typescript and provides desktop notifictions.
* [mkropat/vim-tt](https://github.com/mkropat/vim-tt) allows you to implement your own task tracking method.