* docs: document S3 backend, auto-auth, and `:Pending done` command Problem: The S3 backend had no `:Pending s3` entry in the COMMANDS section, `:Pending auth` only mentioned Google, the `sync` config field omitted `s3`, `_s3_sync_id` was missing from the data format section, `:Pending done` was implemented but undocumented, and the README lacked a features overview. Solution: Add `:Pending s3` and `:Pending done` command docs, rewrite `:Pending auth` to cover all backends and sub-actions, update config and data format references, add `aws` CLI to requirements, and add a Features section to `README.md`. * feat(forge): add forge link parser and metadata fetcher Problem: no way to associate tasks with GitHub, GitLab, or Codeberg issues/PRs, or to track their remote state. Solution: add `forge.lua` with shorthand (`gh:user/repo#42`) and full URL parsing, async metadata fetching via `curl`, label formatting, conceal pattern generation, token resolution, and `refresh()` for state pull (closed/merged -> done). * feat(config): add forge config defaults and `%l` eol specifier Problem: no configuration surface for forge link rendering, icons, issue format, or self-hosted instances. Solution: add `pending.ForgeConfig` class with per-forge `token`, `icon`, `issue_format`, and `instances` fields. Add `%l` to the default `eol_format` so forge labels render in virtual text. * feat(parse): extract forge refs from task body Problem: `parse.body()` had no awareness of forge link tokens, so `gh:user/repo#42` stayed in the description instead of metadata. Solution: add `forge_ref` field to `pending.Metadata` and extend the right-to-left token loop in `body()` to call `forge.parse_ref()` as the final fallback before breaking. * feat(diff): persist forge refs in store on write Problem: forge refs parsed from buffer lines were discarded during diff reconciliation and never stored in the JSON. Solution: thread `forge_ref` through `parse_buffer` entries into `diff.apply`, storing it in `task._extra._forge_ref` for both new and existing tasks. * feat(views): pass forge ref and cache to line metadata Problem: `LineMeta` had no forge fields, so `buffer.lua` could not render forge labels or apply forge-specific highlights. Solution: add `forge_ref` and `forge_cache` fields to `LineMeta`, populated from `task._extra` in both `category_view` and `priority_view`. * feat(buffer): render forge links as concealed text with eol virt text Problem: forge tokens were visible as raw text with no virtual text labels, and the eol separator logic collapsed all gaps when non-adjacent specifiers were absent. Solution: add forge conceal syntax patterns in `setup_syntax()`, add `PendingForge`/`PendingForgeClosed` highlight groups, handle the `%l` specifier in `build_eol_virt()`, fix separator collapsing to buffer one separator between present segments, and change `concealcursor` to `nc` (reveal in visual and insert mode). * feat(complete): add forge shorthand omnifunc completions Problem: no completion support for `gh:`, `gl:`, or `cb:` tokens, requiring users to type owner/repo from memory. Solution: extend `omnifunc` to detect `gh:`/`gl:`/`cb:` prefixes and complete with `owner/repo#` candidates from existing forge refs in the store. * feat: trigger forge refresh on buffer open Problem: forge metadata was never fetched, so virt text highlights could not reflect remote issue/PR state. Solution: call `forge.refresh()` in `M.open()` so metadata is fetched once per `:Pending` invocation rather than on every render. * test(forge): add forge parsing spec Problem: no test coverage for forge link shorthand parsing, URL parsing, label formatting, or API URL generation. Solution: add `spec/forge_spec.lua` covering `_parse_shorthand`, `parse_ref` for all three forges, full URL parsing including nested GitLab groups, `format_label`, and `_api_url`. * docs: document forge links feature Problem: no user-facing documentation for forge link syntax, configuration, or behavior. Solution: add forge links section to `README.md` and `pending.txt` covering shorthand/URL syntax, config options, virtual text rendering, state pull, and auth resolution. * feat(forge): add `find_refs()` inline token scanner Problem: forge tokens were extracted by `parse.body()` which stripped them from the description, making editing awkward and multi-ref lines impossible. Solution: add `find_refs(text)` that scans a string for all forge tokens by whitespace tokenization, returning byte offsets and parsed refs without modifying the input. Remove unused `conceal_patterns()`. * refactor: move forge ref detection from `parse.body()` to `diff` Problem: `parse.body()` stripped forge tokens from the description, losing the raw text. This made inline overlay rendering impossible since the token no longer existed in the buffer. Solution: remove the `forge.parse_ref()` branch from `parse.body()` and call `forge.find_refs()` in `diff.parse_buffer()` instead. The description now retains forge tokens verbatim; `_extra._forge_ref` is still populated from the first matched ref. * feat(buffer): render forge links as inline conceal overlays Problem: forge tokens were stripped from the buffer and shown as EOL virtual text via `%l`. The token disappeared from the editable line, and multi-ref tasks broke. Solution: compute `forge_spans` in `views.lua` with byte offsets for each forge token in the rendered line. In `apply_inline_row()`, place extmarks with `conceal=''` and `virt_text_pos='inline'` to visually replace each raw token with its formatted label. Clear stale `forge_spans` on dirty rows to prevent `end_col` out-of-range errors after edits like `dd`. * fix(config): remove `%l` from default `eol_format` Problem: forge links are now rendered inline, making the `%l` EOL specifier redundant in the default format. Solution: change default `eol_format` from `'%l %c %r %d'` to `'%c %r %d'`. The `%l` specifier remains functional for users who explicitly set it. * test(forge): update specs for inline forge refs Problem: existing tests asserted that `parse.body()` stripped forge tokens from the description and populated `meta.forge_ref`. The `conceal_patterns` test referenced a removed function. Solution: update `parse.body` integration tests to assert tokens stay in the description. Add `find_refs()` tests covering single/multiple refs, URLs, byte offsets, and empty cases. Remove `conceal_patterns` test. Update diff tests to assert description includes the token. * docs: update forge links for inline overlay rendering Problem: documentation described forge tokens as stripped from the description and rendered via EOL `%l` specifier by default. Solution: update forge links section to describe inline conceal overlay rendering. Update default `eol_format` reference. Change `issue_format` field description from "EOL label" to "inline overlay label". * ci: format * refactor(forge): remove `%l` eol specifier, add `auto_close` config, fix icons Problem: `%l` was dead code after inline overlays replaced EOL rendering. Auto-close was always on with no opt-out. Forge icon defaults were empty strings. Solution: remove `%l` from the eol format parser and renderer. Add `forge.auto_close` (default `false`) to gate state-pull. Set nerd font icons: `` (GitHub), `` (GitLab), `` (Codeberg). Keep conceal active in insert mode via `concealcursor = 'nic'`. * fix(config): set correct nerd font icons for forge defaults
437 lines
11 KiB
Lua
437 lines
11 KiB
Lua
local config = require('pending.config')
|
|
local log = require('pending.log')
|
|
|
|
---@class pending.ForgeRef
|
|
---@field forge 'github'|'gitlab'|'codeberg'
|
|
---@field owner string
|
|
---@field repo string
|
|
---@field type 'issue'|'pull_request'|'merge_request'
|
|
---@field number integer
|
|
---@field url string
|
|
|
|
---@class pending.ForgeCache
|
|
---@field title? string
|
|
---@field state 'open'|'closed'|'merged'
|
|
---@field labels? string[]
|
|
---@field fetched_at string
|
|
|
|
---@class pending.forge
|
|
local M = {}
|
|
|
|
---@type table<string, string>
|
|
local FORGE_HOSTS = {
|
|
['github.com'] = 'github',
|
|
['gitlab.com'] = 'gitlab',
|
|
['codeberg.org'] = 'codeberg',
|
|
}
|
|
|
|
---@type table<string, string>
|
|
local FORGE_API_BASE = {
|
|
github = 'https://api.github.com',
|
|
gitlab = 'https://gitlab.com',
|
|
codeberg = 'https://codeberg.org',
|
|
}
|
|
|
|
---@type table<string, string>
|
|
local SHORTHAND_PREFIX = {
|
|
gh = 'github',
|
|
gl = 'gitlab',
|
|
cb = 'codeberg',
|
|
}
|
|
|
|
---@param token string
|
|
---@return pending.ForgeRef?
|
|
function M._parse_shorthand(token)
|
|
local prefix, rest = token:match('^(%l%l):(.+)$')
|
|
if not prefix then
|
|
return nil
|
|
end
|
|
local forge = SHORTHAND_PREFIX[prefix]
|
|
if not forge then
|
|
return nil
|
|
end
|
|
local owner, repo, number = rest:match('^([%w%.%-_]+)/([%w%.%-_]+)#(%d+)$')
|
|
if not owner then
|
|
return nil
|
|
end
|
|
local num = tonumber(number) --[[@as integer]]
|
|
local host = forge == 'github' and 'github.com'
|
|
or forge == 'gitlab' and 'gitlab.com'
|
|
or 'codeberg.org'
|
|
local url = 'https://' .. host .. '/' .. owner .. '/' .. repo .. '/issues/' .. num
|
|
return {
|
|
forge = forge,
|
|
owner = owner,
|
|
repo = repo,
|
|
type = 'issue',
|
|
number = num,
|
|
url = url,
|
|
}
|
|
end
|
|
|
|
---@param url string
|
|
---@return pending.ForgeRef?
|
|
function M._parse_github_url(url)
|
|
local host, owner, repo, kind, number =
|
|
url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$')
|
|
if not host then
|
|
return nil
|
|
end
|
|
if kind ~= 'issues' and kind ~= 'pull' then
|
|
return nil
|
|
end
|
|
local forge_name = FORGE_HOSTS[host]
|
|
if not forge_name then
|
|
local cfg = config.get().forge or {}
|
|
local gh_cfg = cfg.github or {}
|
|
for _, inst in ipairs(gh_cfg.instances or {}) do
|
|
if host == inst then
|
|
forge_name = 'github'
|
|
break
|
|
end
|
|
end
|
|
end
|
|
if forge_name ~= 'github' then
|
|
return nil
|
|
end
|
|
local num = tonumber(number) --[[@as integer]]
|
|
local ref_type = kind == 'pull' and 'pull_request' or 'issue'
|
|
return {
|
|
forge = 'github',
|
|
owner = owner,
|
|
repo = repo,
|
|
type = ref_type,
|
|
number = num,
|
|
url = url,
|
|
}
|
|
end
|
|
|
|
---@param url string
|
|
---@return pending.ForgeRef?
|
|
function M._parse_gitlab_url(url)
|
|
local host, path, kind, number = url:match('^https?://([^/]+)/(.+)/%-/([%w_]+)/(%d+)$')
|
|
if not host then
|
|
return nil
|
|
end
|
|
if kind ~= 'issues' and kind ~= 'merge_requests' then
|
|
return nil
|
|
end
|
|
local forge_name = FORGE_HOSTS[host]
|
|
if not forge_name then
|
|
local cfg = config.get().forge or {}
|
|
local gl_cfg = cfg.gitlab or {}
|
|
for _, inst in ipairs(gl_cfg.instances or {}) do
|
|
if host == inst then
|
|
forge_name = 'gitlab'
|
|
break
|
|
end
|
|
end
|
|
end
|
|
if forge_name ~= 'gitlab' then
|
|
return nil
|
|
end
|
|
local owner, repo = path:match('^(.+)/([^/]+)$')
|
|
if not owner then
|
|
return nil
|
|
end
|
|
local num = tonumber(number) --[[@as integer]]
|
|
local ref_type = kind == 'merge_requests' and 'merge_request' or 'issue'
|
|
return {
|
|
forge = 'gitlab',
|
|
owner = owner,
|
|
repo = repo,
|
|
type = ref_type,
|
|
number = num,
|
|
url = url,
|
|
}
|
|
end
|
|
|
|
---@param url string
|
|
---@return pending.ForgeRef?
|
|
function M._parse_codeberg_url(url)
|
|
local host, owner, repo, kind, number =
|
|
url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$')
|
|
if not host then
|
|
return nil
|
|
end
|
|
if kind ~= 'issues' and kind ~= 'pulls' then
|
|
return nil
|
|
end
|
|
local forge_name = FORGE_HOSTS[host]
|
|
if not forge_name then
|
|
local cfg = config.get().forge or {}
|
|
local cb_cfg = cfg.codeberg or {}
|
|
for _, inst in ipairs(cb_cfg.instances or {}) do
|
|
if host == inst then
|
|
forge_name = 'codeberg'
|
|
break
|
|
end
|
|
end
|
|
end
|
|
if forge_name ~= 'codeberg' then
|
|
return nil
|
|
end
|
|
local num = tonumber(number) --[[@as integer]]
|
|
local ref_type = kind == 'pulls' and 'pull_request' or 'issue'
|
|
return {
|
|
forge = 'codeberg',
|
|
owner = owner,
|
|
repo = repo,
|
|
type = ref_type,
|
|
number = num,
|
|
url = url,
|
|
}
|
|
end
|
|
|
|
---@param token string
|
|
---@return pending.ForgeRef?
|
|
function M.parse_ref(token)
|
|
local short = M._parse_shorthand(token)
|
|
if short then
|
|
return short
|
|
end
|
|
if not token:match('^https?://') then
|
|
return nil
|
|
end
|
|
return M._parse_github_url(token) or M._parse_gitlab_url(token) or M._parse_codeberg_url(token)
|
|
end
|
|
|
|
---@class pending.ForgeSpan
|
|
---@field ref pending.ForgeRef
|
|
---@field start_byte integer
|
|
---@field end_byte integer
|
|
---@field raw string
|
|
|
|
---@param text string
|
|
---@return pending.ForgeSpan[]
|
|
function M.find_refs(text)
|
|
local results = {}
|
|
local pos = 1
|
|
while pos <= #text do
|
|
local ws = text:find('%S', pos)
|
|
if not ws then
|
|
break
|
|
end
|
|
local token_end = text:find('%s', ws)
|
|
local token = token_end and text:sub(ws, token_end - 1) or text:sub(ws)
|
|
local ref = M.parse_ref(token)
|
|
if ref then
|
|
local eb = token_end and (token_end - 1) or #text
|
|
table.insert(results, {
|
|
ref = ref,
|
|
start_byte = ws - 1,
|
|
end_byte = eb,
|
|
raw = token,
|
|
})
|
|
end
|
|
pos = token_end and token_end or (#text + 1)
|
|
end
|
|
return results
|
|
end
|
|
|
|
---@param ref pending.ForgeRef
|
|
---@return string
|
|
function M._api_url(ref)
|
|
if ref.forge == 'github' then
|
|
return FORGE_API_BASE.github
|
|
.. '/repos/'
|
|
.. ref.owner
|
|
.. '/'
|
|
.. ref.repo
|
|
.. '/issues/'
|
|
.. ref.number
|
|
elseif ref.forge == 'gitlab' then
|
|
local encoded = (ref.owner .. '/' .. ref.repo):gsub('/', '%%2F')
|
|
local endpoint = ref.type == 'merge_request' and 'merge_requests' or 'issues'
|
|
return FORGE_API_BASE.gitlab
|
|
.. '/api/v4/projects/'
|
|
.. encoded
|
|
.. '/'
|
|
.. endpoint
|
|
.. '/'
|
|
.. ref.number
|
|
else
|
|
local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues'
|
|
return FORGE_API_BASE.codeberg
|
|
.. '/api/v1/repos/'
|
|
.. ref.owner
|
|
.. '/'
|
|
.. ref.repo
|
|
.. '/'
|
|
.. endpoint
|
|
.. '/'
|
|
.. ref.number
|
|
end
|
|
end
|
|
|
|
---@param ref pending.ForgeRef
|
|
---@param cache? pending.ForgeCache
|
|
---@return string text
|
|
---@return string hl_group
|
|
function M.format_label(ref, cache)
|
|
local cfg = config.get().forge or {}
|
|
local forge_cfg = cfg[ref.forge] or {}
|
|
local fmt = forge_cfg.issue_format or '%i %o/%r#%n'
|
|
local icon = forge_cfg.icon or ''
|
|
local text = fmt
|
|
:gsub('%%i', icon)
|
|
:gsub('%%o', ref.owner)
|
|
:gsub('%%r', ref.repo)
|
|
:gsub('%%n', tostring(ref.number))
|
|
local hl = 'PendingForge'
|
|
if cache then
|
|
if cache.state == 'closed' or cache.state == 'merged' then
|
|
hl = 'PendingForgeClosed'
|
|
end
|
|
end
|
|
return text, hl
|
|
end
|
|
|
|
---@param forge string
|
|
---@return string?
|
|
function M.get_token(forge)
|
|
local cfg = config.get().forge or {}
|
|
local forge_cfg = cfg[forge] or {}
|
|
if forge_cfg.token then
|
|
return forge_cfg.token
|
|
end
|
|
if forge == 'github' then
|
|
local result = vim.fn.system({ 'gh', 'auth', 'token' })
|
|
if vim.v.shell_error == 0 and result and result ~= '' then
|
|
return vim.trim(result)
|
|
end
|
|
elseif forge == 'gitlab' then
|
|
local result = vim.fn.system({ 'glab', 'auth', 'token' })
|
|
if vim.v.shell_error == 0 and result and result ~= '' then
|
|
return vim.trim(result)
|
|
end
|
|
end
|
|
return nil
|
|
end
|
|
|
|
---@param ref pending.ForgeRef
|
|
---@param callback fun(cache: pending.ForgeCache?)
|
|
function M.fetch_metadata(ref, callback)
|
|
local token = M.get_token(ref.forge)
|
|
local url = M._api_url(ref)
|
|
local args = { 'curl', '-s', '-L' }
|
|
if token then
|
|
table.insert(args, '-H')
|
|
if ref.forge == 'gitlab' then
|
|
table.insert(args, 'PRIVATE-TOKEN: ' .. token)
|
|
else
|
|
table.insert(args, 'Authorization: Bearer ' .. token)
|
|
end
|
|
end
|
|
table.insert(args, '-H')
|
|
table.insert(args, 'Accept: application/json')
|
|
table.insert(args, url)
|
|
|
|
vim.system(args, { text = true }, function(result)
|
|
if result.code ~= 0 or not result.stdout or result.stdout == '' then
|
|
vim.schedule(function()
|
|
callback(nil)
|
|
end)
|
|
return
|
|
end
|
|
local ok, decoded = pcall(vim.json.decode, result.stdout)
|
|
if not ok or not decoded then
|
|
vim.schedule(function()
|
|
callback(nil)
|
|
end)
|
|
return
|
|
end
|
|
local state = 'open'
|
|
if ref.forge == 'github' then
|
|
if decoded.pull_request and decoded.pull_request.merged_at then
|
|
state = 'merged'
|
|
elseif decoded.state == 'closed' then
|
|
state = 'closed'
|
|
end
|
|
elseif ref.forge == 'gitlab' then
|
|
if decoded.state == 'merged' then
|
|
state = 'merged'
|
|
elseif decoded.state == 'closed' then
|
|
state = 'closed'
|
|
end
|
|
else
|
|
if decoded.state == 'closed' then
|
|
state = 'closed'
|
|
end
|
|
end
|
|
local labels = {}
|
|
if decoded.labels then
|
|
for _, label in ipairs(decoded.labels) do
|
|
if type(label) == 'string' then
|
|
table.insert(labels, label)
|
|
elseif type(label) == 'table' and label.name then
|
|
table.insert(labels, label.name)
|
|
end
|
|
end
|
|
end
|
|
local cache = {
|
|
title = decoded.title,
|
|
state = state,
|
|
labels = labels,
|
|
fetched_at = os.date('!%Y-%m-%dT%H:%M:%SZ') --[[@as string]],
|
|
}
|
|
vim.schedule(function()
|
|
callback(cache)
|
|
end)
|
|
end)
|
|
end
|
|
|
|
---@param s pending.Store
|
|
function M.refresh(s)
|
|
local tasks = s:tasks()
|
|
local pending_fetches = 0
|
|
local any_changed = false
|
|
local any_fetched = false
|
|
for _, task in ipairs(tasks) do
|
|
if task.status ~= 'deleted' and task._extra and task._extra._forge_ref then
|
|
local ref = task._extra._forge_ref --[[@as pending.ForgeRef]]
|
|
pending_fetches = pending_fetches + 1
|
|
M.fetch_metadata(ref, function(cache)
|
|
pending_fetches = pending_fetches - 1
|
|
if cache then
|
|
task._extra._forge_cache = cache
|
|
any_fetched = true
|
|
local forge_cfg = config.get().forge or {}
|
|
if
|
|
forge_cfg.auto_close
|
|
and (cache.state == 'closed' or cache.state == 'merged')
|
|
and (task.status == 'pending' or task.status == 'wip' or task.status == 'blocked')
|
|
then
|
|
task.status = 'done'
|
|
task['end'] = os.date('!%Y-%m-%dT%H:%M:%SZ') --[[@as string]]
|
|
task.modified = os.date('!%Y-%m-%dT%H:%M:%SZ') --[[@as string]]
|
|
any_changed = true
|
|
end
|
|
else
|
|
task._extra._forge_cache = {
|
|
state = 'open',
|
|
fetched_at = os.date('!%Y-%m-%dT%H:%M:%SZ') --[[@as string]],
|
|
}
|
|
end
|
|
if pending_fetches == 0 then
|
|
if any_changed then
|
|
s:save()
|
|
end
|
|
local buffer = require('pending.buffer')
|
|
if
|
|
(any_changed or any_fetched)
|
|
and buffer.bufnr()
|
|
and vim.api.nvim_buf_is_valid(buffer.bufnr())
|
|
then
|
|
buffer.render()
|
|
end
|
|
end
|
|
end)
|
|
end
|
|
end
|
|
if pending_fetches == 0 then
|
|
log.info('No linked tasks to refresh.')
|
|
end
|
|
end
|
|
|
|
return M
|