subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat(help): accept patterns for readme (#269)

This commit is contained in:
Munif Tanjim 2023-01-02 01:23:41 +06:00 committed by GitHub
parent 11eee43c7e
commit d521a25cfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -436,7 +436,7 @@ return {
-- when the readme opens with :help it will be correctly displayed as markdown -- when the readme opens with :help it will be correctly displayed as markdown
readme = { readme = {
root = vim.fn.stdpath("state") .. "/lazy/readme", root = vim.fn.stdpath("state") .. "/lazy/readme",
files = { "README.md" }, files = { "README.md", "lua/**/README.md" },
-- only generate markdown helptags for plugins that dont have docs -- only generate markdown helptags for plugins that dont have docs
skip_if_doc_exists = true, skip_if_doc_exists = true,
}, },

2
lua/lazy/core/config.lua
View File

@ -135,7 +135,7 @@ M.defaults = {
-- when the readme opens with :help it will be correctly displayed as markdown -- when the readme opens with :help it will be correctly displayed as markdown
readme = { readme = {
root = vim.fn.stdpath("state") .. "/lazy/readme", root = vim.fn.stdpath("state") .. "/lazy/readme",
files = { "README.md" }, files = { "README.md", "lua/**/README.md" },
-- only generate markdown helptags for plugins that dont have docs -- only generate markdown helptags for plugins that dont have docs
skip_if_doc_exists = true, skip_if_doc_exists = true,
}, },

15
lua/lazy/help.lua
View File

@ -7,23 +7,28 @@ function M.index(plugin)
if Config.options.readme.skip_if_doc_exists and vim.loop.fs_stat(plugin.dir .. "/doc") then if Config.options.readme.skip_if_doc_exists and vim.loop.fs_stat(plugin.dir .. "/doc") then
return {} return {}
end end
local files = vim.tbl_flatten(vim.tbl_map(function(file)
return vim.fn.expand(plugin.dir .. "/" .. file, false, true)
end, Config.options.readme.files))
---@type table<string,{file:string, tag:string, line:string}> ---@type table<string,{file:string, tag:string, line:string}>
local tags = {} local tags = {}
for _, file in ipairs(Config.options.readme.files) do for _, file in ipairs(files) do
file = plugin.dir .. "/" .. file file = Util.norm(file)
if vim.loop.fs_stat(file) then if vim.loop.fs_stat(file) then
local rel_file = file:sub(#plugin.dir + 1)
local tag_filename = string.gsub(plugin.name .. vim.fn.fnamemodify(rel_file, ":h:gs?/?-?"), "-$", "")
local lines = vim.split(Util.read_file(file), "\n") local lines = vim.split(Util.read_file(file), "\n")
for _, line in ipairs(lines) do for _, line in ipairs(lines) do
local title = line:match("^#+%s*(.*)") local title = line:match("^#+%s*(.*)")
if title then if title then
local tag = plugin.name .. "-" .. title:lower():gsub("%W+", "-") local tag = tag_filename .. "-" .. title:lower():gsub("%W+", "-")
tag = tag:gsub("%-+", "-"):gsub("%-$", "") tag = tag:gsub("%-+", "-"):gsub("%-$", "")
line = line:gsub("([%[%]/])", "\\%1") line = line:gsub("([%[%]/])", "\\%1")
tags[tag] = { tag = tag, line = line, file = plugin.name .. ".md" } tags[tag] = { tag = tag, line = line, file = tag_filename .. ".md" }
end end
end end
table.insert(lines, [[<!-- vim: set ft=markdown: -->]]) table.insert(lines, [[<!-- vim: set ft=markdown: -->]])
Util.write_file(Config.options.readme.root .. "/doc/" .. plugin.name .. ".md", table.concat(lines, "\n")) Util.write_file(Config.options.readme.root .. "/doc/" .. tag_filename .. ".md", table.concat(lines, "\n"))
end end
end end
return tags return tags