refactor(forge): replace curl/token auth with CLI-native API calls
Problem: Forge metadata fetching required manual token management — config fields, CLI token extraction, and curl with auth headers. Each forge had a different auth path, and Codeberg had no CLI support at all. Solution: Delete `get_token()` and `_api_url()`, replace with `_api_args()` that builds `gh api`, `glab api`, or `tea api` arg arrays. The CLIs handle auth internally. Add `warn_missing_cli` config (default true) that warns once per forge per session on failure. Add forge CLI checks to `:checkhealth`. Remove `token` from config/docs.
This commit is contained in:
parent
54f2eb50d9
commit
ecacb62674
5 changed files with 81 additions and 94 deletions
|
|
@ -1501,20 +1501,18 @@ Configuration: ~
|
||||||
vim.g.pending = {
|
vim.g.pending = {
|
||||||
forge = {
|
forge = {
|
||||||
auto_close = false,
|
auto_close = false,
|
||||||
|
warn_missing_cli = true,
|
||||||
github = {
|
github = {
|
||||||
token = nil,
|
|
||||||
icon = '',
|
icon = '',
|
||||||
issue_format = '%i %o/%r#%n',
|
issue_format = '%i %o/%r#%n',
|
||||||
instances = {},
|
instances = {},
|
||||||
},
|
},
|
||||||
gitlab = {
|
gitlab = {
|
||||||
token = nil,
|
|
||||||
icon = '',
|
icon = '',
|
||||||
issue_format = '%i %o/%r#%n',
|
issue_format = '%i %o/%r#%n',
|
||||||
instances = {},
|
instances = {},
|
||||||
},
|
},
|
||||||
codeberg = {
|
codeberg = {
|
||||||
token = nil,
|
|
||||||
icon = '',
|
icon = '',
|
||||||
issue_format = '%i %o/%r#%n',
|
issue_format = '%i %o/%r#%n',
|
||||||
instances = {},
|
instances = {},
|
||||||
|
|
@ -1524,27 +1522,27 @@ Configuration: ~
|
||||||
<
|
<
|
||||||
|
|
||||||
Top-level fields: ~
|
Top-level fields: ~
|
||||||
{auto_close} (boolean, default: false) When true, tasks linked to
|
{auto_close} (boolean, default: false) When true, tasks linked to
|
||||||
closed/merged remote issues are automatically marked
|
closed/merged remote issues are automatically marked
|
||||||
done on buffer open.
|
done on buffer open.
|
||||||
|
{warn_missing_cli} (boolean, default: true) When true, warns once per
|
||||||
|
forge per session if the CLI is missing or fails.
|
||||||
|
|
||||||
Fields (per forge): ~
|
Fields (per forge): ~
|
||||||
{token} (string, optional) API token for authenticated requests.
|
|
||||||
Falls back to CLI: `gh auth token` (GitHub), `glab auth
|
|
||||||
token` (GitLab). Codeberg uses token only.
|
|
||||||
{icon} (string) Nerd font icon used in virtual text.
|
{icon} (string) Nerd font icon used in virtual text.
|
||||||
{issue_format} (string) Format string for the inline overlay label.
|
{issue_format} (string) Format string for the inline overlay label.
|
||||||
{instances} (string[]) Additional hostnames for self-hosted instances
|
{instances} (string[]) Additional hostnames for self-hosted instances
|
||||||
(e.g. `{ 'github.company.com' }`).
|
(e.g. `{ 'github.company.com' }`).
|
||||||
|
|
||||||
Authentication: ~
|
Authentication: ~
|
||||||
Token retrieval is CLI-preferred, config fallback:
|
Forge metadata fetching uses each forge's native CLI. No tokens are
|
||||||
1. GitHub: `gh auth token` stdout. Falls back to `forge.github.token`.
|
configured in pending.nvim — authenticate once in your shell:
|
||||||
2. GitLab: `glab auth token` stdout. Falls back to `forge.gitlab.token`.
|
1. GitHub: `gh auth login`
|
||||||
3. Codeberg: `forge.codeberg.token` only (no standard CLI).
|
2. GitLab: `glab auth login`
|
||||||
|
3. Codeberg: `tea login add`
|
||||||
|
|
||||||
Unauthenticated requests work for public repositories. Private repositories
|
Public repositories work without authentication. Private repositories
|
||||||
require a token.
|
require a logged-in CLI session.
|
||||||
|
|
||||||
Metadata fetching: ~
|
Metadata fetching: ~
|
||||||
On buffer open, tasks with a `_forge_ref` whose cached metadata is older
|
On buffer open, tasks with a `_forge_ref` whose cached metadata is older
|
||||||
|
|
|
||||||
|
|
@ -34,13 +34,13 @@
|
||||||
---@field region? string
|
---@field region? string
|
||||||
|
|
||||||
---@class pending.ForgeInstanceConfig
|
---@class pending.ForgeInstanceConfig
|
||||||
---@field token? string
|
|
||||||
---@field icon? string
|
---@field icon? string
|
||||||
---@field issue_format? string
|
---@field issue_format? string
|
||||||
---@field instances? string[]
|
---@field instances? string[]
|
||||||
|
|
||||||
---@class pending.ForgeConfig
|
---@class pending.ForgeConfig
|
||||||
---@field auto_close? boolean
|
---@field auto_close? boolean
|
||||||
|
---@field warn_missing_cli? boolean
|
||||||
---@field github? pending.ForgeInstanceConfig
|
---@field github? pending.ForgeInstanceConfig
|
||||||
---@field gitlab? pending.ForgeInstanceConfig
|
---@field gitlab? pending.ForgeInstanceConfig
|
||||||
---@field codeberg? pending.ForgeInstanceConfig
|
---@field codeberg? pending.ForgeInstanceConfig
|
||||||
|
|
@ -156,6 +156,7 @@ local defaults = {
|
||||||
sync = {},
|
sync = {},
|
||||||
forge = {
|
forge = {
|
||||||
auto_close = false,
|
auto_close = false,
|
||||||
|
warn_missing_cli = true,
|
||||||
github = {
|
github = {
|
||||||
icon = '',
|
icon = '',
|
||||||
issue_format = '%i %o/%r#%n',
|
issue_format = '%i %o/%r#%n',
|
||||||
|
|
|
||||||
|
|
@ -26,12 +26,22 @@ local FORGE_HOSTS = {
|
||||||
}
|
}
|
||||||
|
|
||||||
---@type table<string, string>
|
---@type table<string, string>
|
||||||
local FORGE_API_BASE = {
|
local FORGE_CLI = {
|
||||||
github = 'https://api.github.com',
|
github = 'gh',
|
||||||
gitlab = 'https://gitlab.com',
|
gitlab = 'glab',
|
||||||
codeberg = 'https://codeberg.org',
|
codeberg = 'tea',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
---@type table<string, string>
|
||||||
|
local FORGE_AUTH_CMD = {
|
||||||
|
github = 'gh auth login',
|
||||||
|
gitlab = 'glab auth login',
|
||||||
|
codeberg = 'tea login add',
|
||||||
|
}
|
||||||
|
|
||||||
|
---@type table<string, boolean>
|
||||||
|
local _warned_forges = {}
|
||||||
|
|
||||||
---@type table<string, string>
|
---@type table<string, string>
|
||||||
local SHORTHAND_PREFIX = {
|
local SHORTHAND_PREFIX = {
|
||||||
gh = 'github',
|
gh = 'github',
|
||||||
|
|
@ -230,37 +240,29 @@ function M.find_refs(text)
|
||||||
end
|
end
|
||||||
|
|
||||||
---@param ref pending.ForgeRef
|
---@param ref pending.ForgeRef
|
||||||
---@return string
|
---@return string[]
|
||||||
function M._api_url(ref)
|
function M._api_args(ref)
|
||||||
if ref.forge == 'github' then
|
if ref.forge == 'github' then
|
||||||
return FORGE_API_BASE.github
|
return {
|
||||||
.. '/repos/'
|
'gh',
|
||||||
.. ref.owner
|
'api',
|
||||||
.. '/'
|
'/repos/' .. ref.owner .. '/' .. ref.repo .. '/issues/' .. ref.number,
|
||||||
.. ref.repo
|
}
|
||||||
.. '/issues/'
|
|
||||||
.. ref.number
|
|
||||||
elseif ref.forge == 'gitlab' then
|
elseif ref.forge == 'gitlab' then
|
||||||
local encoded = (ref.owner .. '/' .. ref.repo):gsub('/', '%%2F')
|
local encoded = (ref.owner .. '/' .. ref.repo):gsub('/', '%%2F')
|
||||||
local endpoint = ref.type == 'merge_request' and 'merge_requests' or 'issues'
|
local endpoint = ref.type == 'merge_request' and 'merge_requests' or 'issues'
|
||||||
return FORGE_API_BASE.gitlab
|
return {
|
||||||
.. '/api/v4/projects/'
|
'glab',
|
||||||
.. encoded
|
'api',
|
||||||
.. '/'
|
'/projects/' .. encoded .. '/' .. endpoint .. '/' .. ref.number,
|
||||||
.. endpoint
|
}
|
||||||
.. '/'
|
|
||||||
.. ref.number
|
|
||||||
else
|
else
|
||||||
local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues'
|
local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues'
|
||||||
return FORGE_API_BASE.codeberg
|
return {
|
||||||
.. '/api/v1/repos/'
|
'tea',
|
||||||
.. ref.owner
|
'api',
|
||||||
.. '/'
|
'/repos/' .. ref.owner .. '/' .. ref.repo .. '/' .. endpoint .. '/' .. ref.number,
|
||||||
.. ref.repo
|
}
|
||||||
.. '/'
|
|
||||||
.. endpoint
|
|
||||||
.. '/'
|
|
||||||
.. ref.number
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
@ -287,49 +289,21 @@ function M.format_label(ref, cache)
|
||||||
return text, hl
|
return text, hl
|
||||||
end
|
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 ref pending.ForgeRef
|
||||||
---@param callback fun(cache: pending.ForgeCache?)
|
---@param callback fun(cache: pending.ForgeCache?)
|
||||||
function M.fetch_metadata(ref, callback)
|
function M.fetch_metadata(ref, callback)
|
||||||
local token = M.get_token(ref.forge)
|
local args = M._api_args(ref)
|
||||||
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)
|
vim.system(args, { text = true }, function(result)
|
||||||
if result.code ~= 0 or not result.stdout or result.stdout == '' then
|
if result.code ~= 0 or not result.stdout or result.stdout == '' then
|
||||||
vim.schedule(function()
|
vim.schedule(function()
|
||||||
|
local forge_cfg = config.get().forge or {}
|
||||||
|
if forge_cfg.warn_missing_cli ~= false and not _warned_forges[ref.forge] then
|
||||||
|
_warned_forges[ref.forge] = true
|
||||||
|
local cli = FORGE_CLI[ref.forge]
|
||||||
|
local auth_cmd = FORGE_AUTH_CMD[ref.forge]
|
||||||
|
log.warn(('%s not found or not authenticated — run `%s`'):format(cli, auth_cmd))
|
||||||
|
end
|
||||||
callback(nil)
|
callback(nil)
|
||||||
end)
|
end)
|
||||||
return
|
return
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,20 @@ function M.check()
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
vim.health.start('pending.nvim: forge')
|
||||||
|
local forge_clis = {
|
||||||
|
{ cmd = 'gh', name = 'GitHub', hint = 'gh auth login' },
|
||||||
|
{ cmd = 'glab', name = 'GitLab', hint = 'glab auth login' },
|
||||||
|
{ cmd = 'tea', name = 'Codeberg', hint = 'tea login add' },
|
||||||
|
}
|
||||||
|
for _, cli in ipairs(forge_clis) do
|
||||||
|
if vim.fn.executable(cli.cmd) == 1 then
|
||||||
|
vim.health.ok(('%s found'):format(cli.cmd))
|
||||||
|
else
|
||||||
|
vim.health.warn(('%s not found — run `%s`'):format(cli.cmd, cli.hint))
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
local sync_paths = vim.fn.globpath(vim.o.runtimepath, 'lua/pending/sync/*.lua', false, true)
|
local sync_paths = vim.fn.globpath(vim.o.runtimepath, 'lua/pending/sync/*.lua', false, true)
|
||||||
if #sync_paths == 0 then
|
if #sync_paths == 0 then
|
||||||
vim.health.info('No sync backends found')
|
vim.health.info('No sync backends found')
|
||||||
|
|
|
||||||
|
|
@ -186,9 +186,9 @@ describe('forge', function()
|
||||||
end)
|
end)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
describe('_api_url', function()
|
describe('_api_args', function()
|
||||||
it('builds GitHub API URL', function()
|
it('builds GitHub CLI args', function()
|
||||||
local url = forge._api_url({
|
local args = forge._api_args({
|
||||||
forge = 'github',
|
forge = 'github',
|
||||||
owner = 'user',
|
owner = 'user',
|
||||||
repo = 'repo',
|
repo = 'repo',
|
||||||
|
|
@ -196,11 +196,11 @@ describe('forge', function()
|
||||||
number = 42,
|
number = 42,
|
||||||
url = '',
|
url = '',
|
||||||
})
|
})
|
||||||
assert.equals('https://api.github.com/repos/user/repo/issues/42', url)
|
assert.same({ 'gh', 'api', '/repos/user/repo/issues/42' }, args)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
it('builds GitLab API URL for issue', function()
|
it('builds GitLab CLI args for issue', function()
|
||||||
local url = forge._api_url({
|
local args = forge._api_args({
|
||||||
forge = 'gitlab',
|
forge = 'gitlab',
|
||||||
owner = 'group',
|
owner = 'group',
|
||||||
repo = 'project',
|
repo = 'project',
|
||||||
|
|
@ -208,11 +208,11 @@ describe('forge', function()
|
||||||
number = 15,
|
number = 15,
|
||||||
url = '',
|
url = '',
|
||||||
})
|
})
|
||||||
assert.equals('https://gitlab.com/api/v4/projects/group%2Fproject/issues/15', url)
|
assert.same({ 'glab', 'api', '/projects/group%2Fproject/issues/15' }, args)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
it('builds GitLab API URL for merge request', function()
|
it('builds GitLab CLI args for merge request', function()
|
||||||
local url = forge._api_url({
|
local args = forge._api_args({
|
||||||
forge = 'gitlab',
|
forge = 'gitlab',
|
||||||
owner = 'group',
|
owner = 'group',
|
||||||
repo = 'project',
|
repo = 'project',
|
||||||
|
|
@ -220,11 +220,11 @@ describe('forge', function()
|
||||||
number = 5,
|
number = 5,
|
||||||
url = '',
|
url = '',
|
||||||
})
|
})
|
||||||
assert.equals('https://gitlab.com/api/v4/projects/group%2Fproject/merge_requests/5', url)
|
assert.same({ 'glab', 'api', '/projects/group%2Fproject/merge_requests/5' }, args)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
it('builds Codeberg API URL', function()
|
it('builds Codeberg CLI args', function()
|
||||||
local url = forge._api_url({
|
local args = forge._api_args({
|
||||||
forge = 'codeberg',
|
forge = 'codeberg',
|
||||||
owner = 'user',
|
owner = 'user',
|
||||||
repo = 'repo',
|
repo = 'repo',
|
||||||
|
|
@ -232,7 +232,7 @@ describe('forge', function()
|
||||||
number = 3,
|
number = 3,
|
||||||
url = '',
|
url = '',
|
||||||
})
|
})
|
||||||
assert.equals('https://codeberg.org/api/v1/repos/user/repo/issues/3', url)
|
assert.same({ 'tea', 'api', '/repos/user/repo/issues/3' }, args)
|
||||||
end)
|
end)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue