Compare commits

...
Sign in to create a new pull request.

3 commits

Author SHA1 Message Date
8433d92857 ci: format 2026-02-25 09:39:11 -05:00
fa1103ad4e doc: minify readme 2026-02-25 09:37:49 -05:00
Barrett Ruth
fbeb0e2bee
feat(buffer): open as bottom-drawer split like fugitive (#23)
* feat(buffer): open as bottom-drawer split like fugitive

Problem: :Pending replaced the current buffer, making it impossible to
view tasks alongside the file being edited. No way to close the drawer
without :q or switching buffers manually.

Solution: open the task buffer in a botright horizontal split instead of
replacing the current buffer. Track the drawer window ID so re-opening
focuses it rather than creating a second split. Set winfixheight so the
drawer keeps its height when other windows open or close. Add q/<Esc>
mappings to close the drawer, and a WinClosed autocmd to clear the
tracked window ID when the user closes it manually. Add drawer_height
config option (default 15).

* fix(buffer): default to natural split height like fugitive

Problem: hardcoded drawer_height=15 was too small and diverged from
fugitive's model. Fugitive issues a plain botright split and lets Vim's
own split rules (equalalways, winheight) divide the available space.

Solution: remove the default height so the split sizes naturally. Only
call nvim_win_set_height when the user sets drawer_height to a positive
value, preserving the opt-in customization path.
2026-02-25 09:34:17 -05:00
8 changed files with 75 additions and 157 deletions

View file

@ -1,4 +1,4 @@
title: 'Q&A'
title: "Q&A"
labels: []
body:
- type: markdown

View file

@ -1,14 +1,13 @@
name: Bug Report
description: Report a bug
title: 'bug: '
title: "bug: "
labels: [bug]
body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label:
I have searched [existing
- label: I have searched [existing
issues](https://github.com/barrettruth/pending.nvim/issues)
required: true
- label: I have updated to the latest version
@ -16,16 +15,16 @@ body:
- type: textarea
attributes:
label: 'Neovim version'
description: 'Output of `nvim --version`'
label: "Neovim version"
description: "Output of `nvim --version`"
render: text
validations:
required: true
- type: input
attributes:
label: 'Operating system'
placeholder: 'e.g. Arch Linux, macOS 15, Ubuntu 24.04'
label: "Operating system"
placeholder: "e.g. Arch Linux, macOS 15, Ubuntu 24.04"
validations:
required: true
@ -49,8 +48,8 @@ body:
- type: textarea
attributes:
label: 'Health check'
description: 'Output of `:checkhealth task`'
label: "Health check"
description: "Output of `:checkhealth task`"
render: text
- type: textarea

View file

@ -1,14 +1,13 @@
name: Feature Request
description: Suggest a feature
title: 'feat: '
title: "feat: "
labels: [enhancement]
body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label:
I have searched [existing
- label: I have searched [existing
issues](https://github.com/barrettruth/pending.nvim/issues)
required: true

View file

@ -3,7 +3,7 @@ name: luarocks
on:
push:
tags:
- 'v*'
- "v*"
jobs:
quality:

143
README.md
View file

@ -2,145 +2,30 @@
Edit tasks like text. `:w` saves them.
A buffer-centric task manager for Neovim. Tasks live in a plain buffer — add
with `o`, delete with `dd`, reorder with `dd`/`p`, rename by editing. Write the
buffer and the diff is computed against a JSON store. No UI chrome, no floating
windows, no abstractions between you and your tasks.
<!-- insert preview -->
## How it works
## Requirements
```
School
! Read chapter 5 Feb 28
Submit homework Feb 25
- Neovim 0.10+
- (Optionally) `curl` and `openssl` for Google Calendar and Google Task sync
Errands
Buy groceries Mar 01
Clean apartment
```
## Installation
Category headers sit at column 0. Tasks are indented below them. `!` marks
priority. Due dates appear as right-aligned virtual text. Done tasks get
strikethrough. Everything you see is editable buffer text — the IDs are
concealed, and metadata is parsed from inline syntax on save.
## Install
Install with your package manager of choice or via
[luarocks](https://luarocks.org/modules/barrettruth/pending.nvim):
```
luarocks install pending.nvim
```
**lazy.nvim:**
```lua
{ 'barrettruth/pending.nvim' }
```
Requires Neovim 0.10+. No external dependencies for local use. Google Calendar
sync requires `curl` and `openssl`.
## Usage
`:Pending` opens the task buffer. From there, it's just vim:
| Key | Action |
| --------- | ------------------------------- |
| `o` / `O` | Add a new task |
| `dd` | Delete a task (on `:w`) |
| `p` | Paste (duplicates get new IDs) |
| `:w` | Save all changes |
| `<CR>` | Toggle complete (immediate) |
| `<Tab>` | Switch category / priority view |
| `g?` | Show keybind help |
### Inline metadata
Type metadata tokens at the end of a task line before saving:
```
Buy milk due:2026-03-15 cat:Errands
```
On `:w`, the date and category are extracted. The description becomes `Buy milk`,
the due date renders as virtual text, and the task moves under the `Errands`
header.
### Quick add
```vim
:Pending add Buy groceries due:2026-03-15
:Pending add School: Submit homework
```
### Archive
```vim
:Pending archive " purge done tasks older than 30 days
:Pending archive 7 " purge done tasks older than 7 days
```
## Configuration
No `setup()` call required. Set `vim.g.pending` before the plugin loads:
```lua
vim.g.pending = {
data_path = vim.fn.stdpath('data') .. '/pending/tasks.json',
default_view = 'category', -- 'category' or 'priority'
default_category = 'Inbox',
date_format = '%b %d', -- strftime format for virtual text
date_syntax = 'due', -- inline token name (e.g. 'by' for by:2026-03-15)
}
```
All fields are optional. Absent keys use the defaults shown above.
## Google Calendar sync
One-way push of tasks with due dates to a dedicated Google Calendar as all-day
events.
```lua
vim.g.pending = {
gcal = {
calendar = 'Tasks',
credentials_path = '/path/to/client_secret.json',
},
}
```
```vim
:Pending sync
```
On first run, a browser window opens for OAuth consent. The refresh token is
stored at `stdpath('data')/pending/gcal_tokens.json`. Completed or deleted tasks
have their calendar events removed. Due date changes update events in place.
## Mappings
The plugin defines `<Plug>` mappings for custom keybinds:
```lua
vim.keymap.set('n', '<leader>t', '<Plug>(pending-open)')
vim.keymap.set('n', '<leader>T', '<Plug>(pending-toggle)')
```
| Plug mapping | Action |
| -------------------------- | -------------------- |
| `<Plug>(pending-open)` | Open task buffer |
| `<Plug>(pending-toggle)` | Toggle complete |
| `<Plug>(pending-view)` | Switch view |
| `<Plug>(pending-priority)` | Toggle priority flag |
| `<Plug>(pending-date)` | Prompt for due date |
## Data format
Tasks are stored as JSON at `stdpath('data')/pending/tasks.json`. The schema is
versioned and forward-compatible — unknown fields are preserved on round-trip.
## Documentation
```vim
:checkhealth pending
:help pending.nvim
```
## Acknowledgements
- [dooing](https://github.com/atiladefreitas/dooing)
- [todo-comments.nvim](https://github.com/folke/todo-comments.nvim)
- [todotxt.nvim](https://github.com/arnarg/todotxt.nvim)

View file

@ -7,6 +7,8 @@ local M = {}
---@type integer?
local task_bufnr = nil
---@type integer?
local task_winid = nil
local task_ns = vim.api.nvim_create_namespace('pending')
---@type 'category'|'priority'|nil
local current_view = nil
@ -25,11 +27,27 @@ function M.bufnr()
return task_bufnr
end
---@return integer?
function M.winid()
return task_winid
end
---@return string?
function M.current_view_name()
return current_view
end
function M.clear_winid()
task_winid = nil
end
function M.close()
if task_winid and vim.api.nvim_win_is_valid(task_winid) then
vim.api.nvim_win_close(task_winid, false)
end
task_winid = nil
end
---@param bufnr integer
local function set_buf_options(bufnr)
vim.bo[bufnr].buftype = 'acwrite'
@ -50,6 +68,7 @@ local function set_win_options(winid)
vim.wo[winid].foldcolumn = '0'
vim.wo[winid].spell = false
vim.wo[winid].cursorline = true
vim.wo[winid].winfixheight = true
end
---@param bufnr integer
@ -251,24 +270,25 @@ function M.open()
setup_highlights()
store.load()
if task_bufnr and vim.api.nvim_buf_is_valid(task_bufnr) then
local wins = vim.fn.win_findbuf(task_bufnr)
if #wins > 0 then
vim.api.nvim_set_current_win(wins[1])
M.render(task_bufnr)
return task_bufnr
end
vim.api.nvim_set_current_buf(task_bufnr)
set_win_options(vim.api.nvim_get_current_win())
if task_winid and vim.api.nvim_win_is_valid(task_winid) then
vim.api.nvim_set_current_win(task_winid)
M.render(task_bufnr)
return task_bufnr
return task_bufnr --[[@as integer]]
end
task_bufnr = vim.api.nvim_create_buf(true, false)
if not (task_bufnr and vim.api.nvim_buf_is_valid(task_bufnr)) then
task_bufnr = vim.api.nvim_create_buf(true, false)
set_buf_options(task_bufnr)
end
set_buf_options(task_bufnr)
vim.api.nvim_set_current_buf(task_bufnr)
set_win_options(vim.api.nvim_get_current_win())
vim.cmd('botright new')
task_winid = vim.api.nvim_get_current_win()
vim.api.nvim_win_set_buf(task_winid, task_bufnr)
local h = config.get().drawer_height
if h and h > 0 then
vim.api.nvim_win_set_height(task_winid, h)
end
set_win_options(task_winid)
M.render(task_bufnr)

View file

@ -9,6 +9,7 @@
---@field date_format string
---@field date_syntax string
---@field category_order? string[]
---@field drawer_height? integer
---@field gcal? pending.GcalConfig
---@class pending.config

View file

@ -38,11 +38,25 @@ function M._setup_autocmds(bufnr)
end
end,
})
vim.api.nvim_create_autocmd('WinClosed', {
group = group,
callback = function(ev)
if tonumber(ev.match) == buffer.winid() then
buffer.clear_winid()
end
end,
})
end
---@param bufnr integer
function M._setup_buf_mappings(bufnr)
local opts = { buffer = bufnr, silent = true }
vim.keymap.set('n', 'q', function()
buffer.close()
end, opts)
vim.keymap.set('n', '<Esc>', function()
buffer.close()
end, opts)
vim.keymap.set('n', '<CR>', function()
M.toggle_complete()
end, opts)