-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: README.md files are now automagically added to help. By default…
… only when no doc/ exists
- Loading branch information
Showing
3 changed files
with
62 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters