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 ---@param file string 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 local tags = {} for _, file in ipairs(files) do file = Util.norm(file) if vim.loop.fs_stat(file) then local rel_file = file:sub(#plugin.dir + 1) local tag_filename = plugin.name .. vim.fn.fnamemodify(rel_file, ":h"):gsub("%W+", "-"):gsub("^%-$", "") 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 = tag_filename .. "-" .. title:lower():gsub("%W+", "-") tag = tag:gsub("%-+", "-"):gsub("%-$", "") line = line:gsub("([%[%]/])", "\\%1") tags[tag] = { tag = tag, line = line, file = tag_filename .. ".md" } end end table.insert(lines, [[]]) Util.write_file(Config.options.readme.root .. "/doc/" .. tag_filename .. ".md", table.concat(lines, "\n")) end end return tags end function M.update() if Config.plugins["lazy.nvim"] then vim.cmd.helptags(Config.plugins["lazy.nvim"].dir .. "/doc") end if Config.options.readme.enabled == false then return end 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 for key, tag in pairs(M.index(plugin)) do tags[key] = tag end end local lines = { [[!_TAG_FILE_ENCODING utf-8 //]] } Util.foreach(tags, function(_, tag) table.insert(lines, ("%s\t%s\t/%s"):format(tag.tag, tag.file, tag.line)) end, { case_sensitive = true }) Util.write_file(docs .. "/tags", table.concat(lines, "\n")) end return M