mirror/folke.lazy.nvim
1
0
Fork 0
mirror of https://github.com/folke/lazy.nvim.git synced 2025-06-24 17:58:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: document highlight groups

Browse source
This commit is contained in:
Folke Lemaitre 2022-12-26 09:37:26 +01:00
parent aed842ae1e
commit 5f017bf655
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
3 changed files with 69 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

50
lua/lazy/docs.lua
View file

@ -10,26 +10,6 @@ function M.indent(str, indent)
return table.concat(lines, "\n")
end
function M.toc(md)
local toc = {}
local lines = vim.split(md, "\n")
local toc_found = false
for _, line in ipairs(lines) do
local hash, title = line:match("^(#+)%s*(.*)")
if hash then
if toc_found then
local anchor = string.gsub(title:lower(), "[^\32-\126]", "")
anchor = string.gsub(anchor, " ", "-")
toc[#toc + 1] = string.rep(" ", #hash - 1) .. "- [" .. title .. "](#" .. anchor .. ")"
end
if title:find("Table of Contents") then
toc_found = true
end
end
end
return M.fix_indent(table.concat(toc, "\n"))
end
---@param str string
function M.fix_indent(str)
local lines = vim.split(str, "\n")
@ -48,7 +28,6 @@ end
---@param contents table<string, string>
function M.save(contents)
local readme = Util.read_file("README.md")
-- contents.toc = M.toc(readme)
for tag, content in pairs(contents) do
content = M.fix_indent(content)
content = content:gsub("%%", "%%%%")
@ -57,7 +36,7 @@ function M.save(contents)
if not readme:find(pattern) then
error("tag " .. tag .. " not found")
end
if tag == "toc" or tag == "commands" then
if tag == "commands" or tag == "colors" then
readme = readme:gsub(pattern, "%1\n\n" .. content .. "\n\n%2")
else
readme = readme:gsub(pattern, "%1\n\n```lua\n" .. content .. "\n```\n\n%2")
@ -104,6 +83,12 @@ function M.commands()
end
end
end)
return M.table(lines)
end
---@param lines string[][]
function M.table(lines)
---@type string[]
local ret = {}
for _, line in ipairs(lines) do
ret[#ret + 1] = "| " .. table.concat(line, " | ") .. " |"
@ -111,6 +96,26 @@ function M.commands()
return table.concat(ret, "\n")
end
function M.colors()
local str = M.extract("lua/lazy/view/colors.lua", "\nM%.colors = ({.-\n})")
---@type table<string,string>
local comments = {}
for _, line in ipairs(vim.split(str, "\n")) do
local group, desc = line:match("^ (%w+) = .* -- (.*)")
if group then
comments[group] = desc
end
end
local lines = {
{ "Highlight Group", "Default Group", "Description" },
{ "---", "---", "---" },
}
Util.foreach(require("lazy.view.colors").colors, function(group, link)
lines[#lines + 1] = { "**Lazy" .. group .. "**", "***" .. link .. "***", comments[group] or "" }
end)
return M.table(lines)
end
function M.update()
local cache_config = M.extract("lua/lazy/core/cache.lua", "\nM%.config = ({.-\n})")
local config = M.extract("lua/lazy/core/config.lua", "\nM%.defaults = ({.-\n})")
@ -124,6 +129,7 @@ function M.update()
config = config,
spec = Util.read_file("lua/lazy/example.lua"),
commands = M.commands(),
colors = M.colors(),
})
vim.cmd.checktime()
end