feat: update helpdocs

This commit is contained in:
Barrett Ruth 2026-03-28 12:43:55 -04:00
parent afb5d93853
commit 4ae7439a75
No known key found for this signature in database
GPG key ID: A6C96C9349D2FC81
4 changed files with 101 additions and 96 deletions

View file

@ -13,11 +13,11 @@ local M = {}
---@field hosts string[]
---@class forge.KeysConfig
---@field pr forge.PRPickerKeys
---@field issue forge.IssuePickerKeys
---@field ci forge.CIPickerKeys
---@field commits forge.CommitsPickerKeys
---@field branches forge.BranchesPickerKeys
---@field pr forge.PRPickerKeys?
---@field issue forge.IssuePickerKeys?
---@field ci forge.CIPickerKeys?
---@field commits forge.CommitsPickerKeys?
---@field branches forge.BranchesPickerKeys?
---@class forge.PRPickerKeys
---@field checkout string|false
@ -256,6 +256,7 @@ end
---@field create_pr_cmd fun(self: forge.Forge, title: string, body: string, base: string, draft: boolean, reviewers: string[]?): string[]
---@field create_pr_web_cmd fun(self: forge.Forge): string[]?
---@field default_branch_cmd fun(self: forge.Forge): string[]
---@field checks_json_cmd (fun(self: forge.Forge, num: string): string[])?
---@field template_paths fun(self: forge.Forge): string[]
---@type table<string, forge.Forge>
@ -461,12 +462,12 @@ local function parse_iso(iso)
return nil
end
local ok, ts = pcall(os.time, {
year = tonumber(y),
month = tonumber(mo),
day = tonumber(d),
hour = tonumber(h),
min = tonumber(mi),
sec = tonumber(s),
year = tonumber(y) --[[@as integer]],
month = tonumber(mo) --[[@as integer]],
day = tonumber(d) --[[@as integer]],
hour = tonumber(h) --[[@as integer]],
min = tonumber(mi) --[[@as integer]],
sec = tonumber(s) --[[@as integer]],
})
if ok and ts then
return ts

View file

@ -1,6 +1,6 @@
local M = {}
---@param result vim.SystemCompleted
---@param result { code: integer, stdout: string?, stderr: string? }
---@param fallback string
---@return string
local function cmd_error(result, fallback)
@ -186,12 +186,14 @@ local function pr_actions(f, num)
},
}
---@type table<string, function>
local name_to_fn = {}
for _, def in ipairs(defs) do
name_to_fn[def.name] = def.fn
end
local actions = build_actions('pr', defs)
---@type table<string, function>
actions._by_name = name_to_fn
return actions
end
@ -522,7 +524,7 @@ function M.ci(f, branch)
end
end
---@param f forge.Forge
---@param f forge.Forge?
function M.commits(f)
local forge_mod = require('forge')
local review = require('forge.review')

View file

@ -19,11 +19,6 @@ end
function M.stop()
M.state.base = nil
M.state.mode = 'unified'
local cfg = require('forge').config()
local lhs = cfg.keys ~= false and cfg.keys.review_toggle
if lhs then
pcall(vim.keymap.del, 'n', lhs)
end
vim.api.nvim_clear_autocmds({ group = review_augroup })
end
@ -61,11 +56,6 @@ end
function M.start(base, mode)
M.state.base = base
M.state.mode = mode or 'unified'
local cfg = require('forge').config()
local lhs = cfg.keys ~= false and cfg.keys.review_toggle
if lhs then
vim.keymap.set('n', lhs, M.toggle, { desc = 'toggle review split/unified' })
end
vim.api.nvim_clear_autocmds({ group = review_augroup })
vim.api.nvim_create_autocmd('BufWipeout', {
group = review_augroup,