mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 10:49:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(docs): better handling of overloads

Browse source
This commit is contained in:
Folke Lemaitre 2024-11-04 20:24:32 +01:00
parent 8a5c4d22a6
commit 038b28319c
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
1 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
lua/snacks/docs.lua
View file

@ -55,7 +55,7 @@ function M.md(str)
local ret = {} ---@type string[]
if #comments > 0 then
table.insert(ret, table.concat(comments, "\n"))
table.insert(ret, vim.trim(table.concat(comments, "\n")))
table.insert(ret, "")
end
if #lines > 0 then
@ -94,14 +94,31 @@ function M.render(name, info)
end
if info.mod then
add(M.md(info.mod .. prefix .. " = {}"))
local mod_lines = vim.split(info.mod, "\n")
mod_lines = vim.tbl_filter(function(line)
local overload = line:match("^%-%-%-%s*@overload (.*)(%s*)$") --[[@as string?]]
if overload then
table.insert(info.methods, {
name = "",
args = "",
type = "",
comment = "---@type " .. overload,
})
return false
elseif line:find("^%s*$") then
return false
end
return true
end, mod_lines)
table.insert(mod_lines, prefix .. " = {}")
add(M.md(table.concat(mod_lines, "\n")))
end
table.sort(info.methods, function(a, b)
if a.type == b.type then
return a.name < b.name
end
return a.type == "."
return a.type < b.type
end)
for _, method in ipairs(info.methods) do