feat: README.md files are now automagically added to help. By default only when no doc/ exists

This commit is contained in:
Folke Lemaitre 2022-12-15 14:07:37 +01:00
parent 27178b5e67
commit 70ca110ca1
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
3 changed files with 62 additions and 1 deletions

View File

@ -75,6 +75,11 @@ M.defaults = {
},
},
},
readme = {
root = vim.fn.stdpath("state") .. "/lazy/readme",
files = { "README.md" },
skip_if_doc_exists = true,
},
debug = false,
}
@ -112,6 +117,7 @@ function M.setup(spec, opts)
vim.fn.stdpath("config"),
}
end
vim.opt.rtp:append(M.options.readme.root)
-- disable plugin loading since we do all of that ourselves
vim.go.loadplugins = false

52
lua/lazy/help.lua Normal file
View File

@ -0,0 +1,52 @@
local Config = require("lazy.core.config")
local Util = require("lazy.util")
local M = {}
function M.index(plugin)
if Config.options.readme.skip_if_doc_exists and vim.loop.fs_stat(plugin.dir .. "/doc") then
return {}
end
---@type {file:string, tag:string, line:string}[]
local tags = {}
for _, file in ipairs(Config.options.readme.files) do
file = plugin.dir .. "/" .. file
if vim.loop.fs_stat(file) then
local lines = vim.split(Util.read_file(file), "\n")
for _, line in ipairs(lines) do
local title = line:match("^#+%s*(.*)")
if title then
local tag = plugin.name .. "-" .. title:lower():gsub("%W+", "-")
tag = tag:gsub("%-+", "-"):gsub("%-$", "")
table.insert(tags, { tag = tag, line = line, file = plugin.name .. ".md" })
end
end
table.insert(lines, [[<!-- vim: set ft=markdown: -->]])
Util.write_file(Config.options.readme.root .. "/doc/" .. plugin.name .. ".md", table.concat(lines, "\n"))
end
end
return tags
end
function M.update()
local docs = Config.options.readme.root .. "/doc"
vim.fn.mkdir(docs, "p")
Util.ls(docs, function(path, name, type)
if type == "file" and name:sub(-2) == "md" then
vim.loop.fs_unlink(path)
end
end)
---@type {file:string, tag:string, line:string}[]
local tags = {}
for _, plugin in pairs(Config.plugins) do
vim.list_extend(tags, M.index(plugin))
end
local lines = { [[!_TAG_FILE_ENCODING utf-8 //]] }
for _, tag in ipairs(tags) do
table.insert(lines, ("%s\t%s\t/%s"):format(tag.tag, tag.file, tag.line))
end
Util.write_file(docs .. "/tags", table.concat(lines, "\n"))
end
return M

View File

@ -65,7 +65,9 @@ function M.install(opts)
plugins = function(plugin)
return plugin.url and not plugin._.installed
end,
}, opts)
}, opts):wait(function()
require("lazy.help").update()
end)
end
---@param opts? ManagerOpts|{lockfile?:boolean}
@ -86,6 +88,7 @@ function M.update(opts)
end,
}, opts):wait(function()
require("lazy.manage.lock").update()
require("lazy.help").update()
end)
end