* feat(config): add recur_syntax and someday_date fields Problem: the plugin needs configuration for the recurrence token name and the sentinel date used by the `later`/`someday` named dates. Solution: add `recur_syntax` (default 'rec') and `someday_date` (default '9999-12-30') to pending.Config and the defaults table. * feat(parse): expand date vocabulary with named dates Problem: the date input only supports today, tomorrow, +Nd, and weekday names, lacking relative offsets like weeks/months, period boundaries, ordinals, month names, and backdating. Solution: add yesterday, eod, sow/eow, som/eom, soq/eoq, soy/eoy, +Nw, +Nm, -Nd, -Nw, ordinals (1st-31st), month names (jan-dec), and later/someday to resolve_date(). Add tests for all new tokens. * feat(recur): add recurrence parsing and next-date computation Problem: the plugin has no concept of recurring tasks, which is needed for habits and repeating deadlines. Solution: add recur.lua with parse(), validate(), next_due(), to_rrule(), and shorthand_list(). Supports named shorthands (daily, weekdays, weekly, etc.), interval notation (Nd, Nw, Nm, Ny), raw RRULE passthrough, and ! prefix for completion-based mode. Includes day-clamping for month/year advancement. * feat(store): add recur and recur_mode task fields Problem: the task schema has no fields for storing recurrence rules. Solution: add recur and recur_mode to the Task class, known_fields, task_to_table, table_to_task, and the add() signature. * feat(parse): add rec: inline token parsing Problem: the buffer parser does not recognize recurrence tokens, so users cannot set recurrence rules inline. Solution: add recur_key() helper and rec: token parsing in body() and command_add(), with ! prefix handling for completion-based mode and validation via recur.validate(). * feat(diff): propagate recurrence through buffer reconciliation Problem: the diff layer does not extract or apply recurrence fields, so rec: tokens written in the buffer are silently ignored on :w. Solution: add rec and rec_mode to ParsedEntry, extract them in parse_buffer(), and pass them through create and update paths in apply(). * feat(init): spawn next task on recurring task completion Problem: completing a recurring task does not create the next occurrence, and :Pending add does not pass recurrence fields. Solution: in toggle_complete(), detect recurrence and spawn a new pending task with the next due date. Wire rec/rec_mode through the add() command path. * feat(views): add recurrence to LineMeta Problem: LineMeta does not carry recurrence info, so the buffer layer cannot display recurrence indicators. Solution: add recur field to LineMeta and populate it in both category_view() and priority_view(). * feat(buffer): add PendingRecur highlight and recurrence virtual text Problem: recurring tasks have no visual indicator in the buffer, and the extmark logic uses a rigid if/elseif chain that does not compose well with additional virtual text fields. Solution: add PendingRecur highlight group linking to DiagnosticInfo. Refactor apply_extmarks() to build virtual text parts dynamically, appending category, recurrence indicator, and due date as separate composable segments. Set omnifunc on the pending buffer. * feat(complete): add omnifunc for cat:, due:, and rec: tokens Problem: the pending buffer has no completion source, requiring users to type metadata tokens from memory. Solution: add complete.lua with an omnifunc that completes cat: tokens from existing categories, due: tokens from the named date vocabulary, and rec: tokens from recurrence shorthands. * docs: document recurrence, expanded dates, omnifunc, new config Problem: the vimdoc does not cover recurrence, expanded date syntax, omnifunc completion, or the new config fields. Solution: add DATE INPUT and RECURRENCE sections, update INLINE METADATA, COMMANDS, CONFIGURATION, HIGHLIGHT GROUPS, HEALTH CHECK, and DATA FORMAT. Expand the help popup with recurrence patterns and new date tokens. Add recurrence validation to healthcheck. * ci: fix * fix(recur): resolve LuaLS type errors Problem: LuaLS reported undefined-field for `_raw` on RecurSpec and param-type-mismatch for `last_day.day` in `advance_date` because `osdate.day` infers as `string|integer`. Solution: Add `_raw` to the RecurSpec class annotation and cast `last_day.day` to integer in both `math.min` call sites. * refactor(init): remove help popup, use config-driven keymaps Problem: Buffer-local keymaps were hardcoded with no way for users to customize them. The g? help popup duplicated information already in the vimdoc. Solution: Remove show_help() and the g? mapping. Refactor _setup_buf_mappings to read from cfg.keymaps, letting users override or disable any buffer-local binding via vim.g.pending. * feat(config): add keymaps table for buffer-local bindings Problem: Users had no way to customize or disable buffer-local key bindings in the pending buffer. Solution: Add a pending.Keymaps class and keymaps field to pending.Config with defaults for all eight buffer actions. Setting any key to false disables that binding. * feat(plugin): add Plug mappings for all buffer actions Problem: Only five of nine buffer actions had <Plug> mappings, so users could not bind close, undo, open-line, or open-line-above globally. Solution: Add <Plug>(pending-close), <Plug>(pending-undo), <Plug>(pending-open-line), and <Plug>(pending-open-line-above). * docs: update mappings and config for keymaps and new Plug entries Problem: Vimdoc still listed g? help popup, lacked documentation for the four new <Plug> mappings, and had no keymaps config section. Solution: Remove g? from mappings table, document all nine <Plug> mappings, add keymaps table to the config example and field reference, and note that buffer-local keys are configurable.
337 lines
7 KiB
Lua
337 lines
7 KiB
Lua
local config = require('pending.config')
|
|
|
|
---@class pending.Task
|
|
---@field id integer
|
|
---@field description string
|
|
---@field status 'pending'|'done'|'deleted'
|
|
---@field category? string
|
|
---@field priority integer
|
|
---@field due? string
|
|
---@field recur? string
|
|
---@field recur_mode? 'scheduled'|'completion'
|
|
---@field entry string
|
|
---@field modified string
|
|
---@field end? string
|
|
---@field order integer
|
|
---@field _extra? table<string, any>
|
|
|
|
---@class pending.Data
|
|
---@field version integer
|
|
---@field next_id integer
|
|
---@field tasks pending.Task[]
|
|
|
|
---@class pending.store
|
|
local M = {}
|
|
|
|
local SUPPORTED_VERSION = 1
|
|
|
|
---@type pending.Data?
|
|
local _data = nil
|
|
|
|
---@return pending.Data
|
|
local function empty_data()
|
|
return {
|
|
version = SUPPORTED_VERSION,
|
|
next_id = 1,
|
|
tasks = {},
|
|
}
|
|
end
|
|
|
|
---@param path string
|
|
local function ensure_dir(path)
|
|
local dir = vim.fn.fnamemodify(path, ':h')
|
|
if vim.fn.isdirectory(dir) == 0 then
|
|
vim.fn.mkdir(dir, 'p')
|
|
end
|
|
end
|
|
|
|
---@return string
|
|
local function timestamp()
|
|
return os.date('!%Y-%m-%dT%H:%M:%SZ') --[[@as string]]
|
|
end
|
|
|
|
---@type table<string, true>
|
|
local known_fields = {
|
|
id = true,
|
|
description = true,
|
|
status = true,
|
|
category = true,
|
|
priority = true,
|
|
due = true,
|
|
recur = true,
|
|
recur_mode = true,
|
|
entry = true,
|
|
modified = true,
|
|
['end'] = true,
|
|
order = true,
|
|
}
|
|
|
|
---@param task pending.Task
|
|
---@return table
|
|
local function task_to_table(task)
|
|
local t = {
|
|
id = task.id,
|
|
description = task.description,
|
|
status = task.status,
|
|
entry = task.entry,
|
|
modified = task.modified,
|
|
}
|
|
if task.category then
|
|
t.category = task.category
|
|
end
|
|
if task.priority and task.priority ~= 0 then
|
|
t.priority = task.priority
|
|
end
|
|
if task.due then
|
|
t.due = task.due
|
|
end
|
|
if task.recur then
|
|
t.recur = task.recur
|
|
end
|
|
if task.recur_mode then
|
|
t.recur_mode = task.recur_mode
|
|
end
|
|
if task['end'] then
|
|
t['end'] = task['end']
|
|
end
|
|
if task.order and task.order ~= 0 then
|
|
t.order = task.order
|
|
end
|
|
if task._extra then
|
|
for k, v in pairs(task._extra) do
|
|
t[k] = v
|
|
end
|
|
end
|
|
return t
|
|
end
|
|
|
|
---@param t table
|
|
---@return pending.Task
|
|
local function table_to_task(t)
|
|
local task = {
|
|
id = t.id,
|
|
description = t.description,
|
|
status = t.status or 'pending',
|
|
category = t.category,
|
|
priority = t.priority or 0,
|
|
due = t.due,
|
|
recur = t.recur,
|
|
recur_mode = t.recur_mode,
|
|
entry = t.entry,
|
|
modified = t.modified,
|
|
['end'] = t['end'],
|
|
order = t.order or 0,
|
|
_extra = {},
|
|
}
|
|
for k, v in pairs(t) do
|
|
if not known_fields[k] then
|
|
task._extra[k] = v
|
|
end
|
|
end
|
|
if next(task._extra) == nil then
|
|
task._extra = nil
|
|
end
|
|
return task
|
|
end
|
|
|
|
---@return pending.Data
|
|
function M.load()
|
|
local path = config.get().data_path
|
|
local f = io.open(path, 'r')
|
|
if not f then
|
|
_data = empty_data()
|
|
return _data
|
|
end
|
|
local content = f:read('*a')
|
|
f:close()
|
|
if content == '' then
|
|
_data = empty_data()
|
|
return _data
|
|
end
|
|
local ok, decoded = pcall(vim.json.decode, content)
|
|
if not ok then
|
|
error('pending.nvim: failed to parse ' .. path .. ': ' .. tostring(decoded))
|
|
end
|
|
if decoded.version and decoded.version > SUPPORTED_VERSION then
|
|
error(
|
|
'pending.nvim: data file version '
|
|
.. decoded.version
|
|
.. ' is newer than supported version '
|
|
.. SUPPORTED_VERSION
|
|
.. '. Please update the plugin.'
|
|
)
|
|
end
|
|
_data = {
|
|
version = decoded.version or SUPPORTED_VERSION,
|
|
next_id = decoded.next_id or 1,
|
|
tasks = {},
|
|
}
|
|
for _, t in ipairs(decoded.tasks or {}) do
|
|
table.insert(_data.tasks, table_to_task(t))
|
|
end
|
|
return _data
|
|
end
|
|
|
|
function M.save()
|
|
if not _data then
|
|
return
|
|
end
|
|
local path = config.get().data_path
|
|
ensure_dir(path)
|
|
local out = {
|
|
version = _data.version,
|
|
next_id = _data.next_id,
|
|
tasks = {},
|
|
}
|
|
for _, task in ipairs(_data.tasks) do
|
|
table.insert(out.tasks, task_to_table(task))
|
|
end
|
|
local encoded = vim.json.encode(out)
|
|
local tmp = path .. '.tmp'
|
|
local f = io.open(tmp, 'w')
|
|
if not f then
|
|
error('pending.nvim: cannot write to ' .. tmp)
|
|
end
|
|
f:write(encoded)
|
|
f:close()
|
|
local ok, rename_err = os.rename(tmp, path)
|
|
if not ok then
|
|
os.remove(tmp)
|
|
error('pending.nvim: cannot rename ' .. tmp .. ' to ' .. path .. ': ' .. tostring(rename_err))
|
|
end
|
|
end
|
|
|
|
---@return pending.Data
|
|
function M.data()
|
|
if not _data then
|
|
M.load()
|
|
end
|
|
return _data --[[@as pending.Data]]
|
|
end
|
|
|
|
---@return pending.Task[]
|
|
function M.tasks()
|
|
return M.data().tasks
|
|
end
|
|
|
|
---@return pending.Task[]
|
|
function M.active_tasks()
|
|
local result = {}
|
|
for _, task in ipairs(M.tasks()) do
|
|
if task.status ~= 'deleted' then
|
|
table.insert(result, task)
|
|
end
|
|
end
|
|
return result
|
|
end
|
|
|
|
---@param id integer
|
|
---@return pending.Task?
|
|
function M.get(id)
|
|
for _, task in ipairs(M.tasks()) do
|
|
if task.id == id then
|
|
return task
|
|
end
|
|
end
|
|
return nil
|
|
end
|
|
|
|
---@param fields { description: string, status?: string, category?: string, priority?: integer, due?: string, recur?: string, recur_mode?: string, order?: integer, _extra?: table }
|
|
---@return pending.Task
|
|
function M.add(fields)
|
|
local data = M.data()
|
|
local now = timestamp()
|
|
local task = {
|
|
id = data.next_id,
|
|
description = fields.description,
|
|
status = fields.status or 'pending',
|
|
category = fields.category or config.get().default_category,
|
|
priority = fields.priority or 0,
|
|
due = fields.due,
|
|
recur = fields.recur,
|
|
recur_mode = fields.recur_mode,
|
|
entry = now,
|
|
modified = now,
|
|
['end'] = nil,
|
|
order = fields.order or 0,
|
|
_extra = fields._extra,
|
|
}
|
|
data.next_id = data.next_id + 1
|
|
table.insert(data.tasks, task)
|
|
return task
|
|
end
|
|
|
|
---@param id integer
|
|
---@param fields table<string, any>
|
|
---@return pending.Task?
|
|
function M.update(id, fields)
|
|
local task = M.get(id)
|
|
if not task then
|
|
return nil
|
|
end
|
|
local now = timestamp()
|
|
for k, v in pairs(fields) do
|
|
if k ~= 'id' and k ~= 'entry' then
|
|
task[k] = v
|
|
end
|
|
end
|
|
task.modified = now
|
|
if fields.status == 'done' or fields.status == 'deleted' then
|
|
task['end'] = task['end'] or now
|
|
end
|
|
return task
|
|
end
|
|
|
|
---@param id integer
|
|
---@return pending.Task?
|
|
function M.delete(id)
|
|
return M.update(id, { status = 'deleted', ['end'] = timestamp() })
|
|
end
|
|
|
|
---@param id integer
|
|
---@return integer?
|
|
function M.find_index(id)
|
|
for i, task in ipairs(M.tasks()) do
|
|
if task.id == id then
|
|
return i
|
|
end
|
|
end
|
|
return nil
|
|
end
|
|
|
|
---@param tasks pending.Task[]
|
|
function M.replace_tasks(tasks)
|
|
M.data().tasks = tasks
|
|
end
|
|
|
|
---@return pending.Task[]
|
|
function M.snapshot()
|
|
local result = {}
|
|
for _, task in ipairs(M.active_tasks()) do
|
|
local copy = {}
|
|
for k, v in pairs(task) do
|
|
if k ~= '_extra' then
|
|
copy[k] = v
|
|
end
|
|
end
|
|
if task._extra then
|
|
copy._extra = {}
|
|
for k, v in pairs(task._extra) do
|
|
copy._extra[k] = v
|
|
end
|
|
end
|
|
table.insert(result, copy --[[@as pending.Task]])
|
|
end
|
|
return result
|
|
end
|
|
|
|
---@param id integer
|
|
function M.set_next_id(id)
|
|
M.data().next_id = id
|
|
end
|
|
|
|
function M.unload()
|
|
_data = nil
|
|
end
|
|
|
|
return M
|