mirror/LazyVim.LazyVim
1
0
Fork 0
mirror of https://github.com/LazyVim/LazyVim.git synced 2025-07-25 13:15:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: updated generated docs

Browse source
This commit is contained in:
Folke Lemaitre 2023-01-09 09:54:02 +01:00
parent c4b1408182
commit 6fdb06cd80
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
2 changed files with 116 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

58
lua/lazyvim/util/build.lua
View file

@ -1,9 +1,11 @@
-- Ugly code to generate some things for the readme
local Util = require("lazy.util")
local M = {}
local root = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":h:h:h:h")
---@return ReadmeBlock
function M.keymaps()
local root = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":h:h:h:h")
local keymap_set = vim.keymap.set
---@type table<string,{mode?:string|string[], keys:string, desc?:string, i:number, group:string}>
local keymaps = {}
@ -42,7 +44,7 @@ function M.keymaps()
group = "Plugins"
require("lazy.util").foreach(require("lazy.core.config").plugins, function(name, plugin)
Util.foreach(require("lazy.core.config").plugins, function(name, plugin)
for _, key in ipairs(plugin.keys or {}) do
if type(key) == "table" and key.desc then
local desc = key.desc or ""
@ -85,14 +87,58 @@ function M.keymaps()
lines[#lines + 1] = "</details>"
lines[#lines + 1] = ""
end
return table.concat(lines, "\n")
return { content = table.concat(lines, "\n") }
end
function M.update()
local Docs = require("lazy.docs")
Docs.plugins()
Docs.save({ keymaps = M.keymaps() })
vim.cmd.checktime()
---@type table<string, ReadmeBlock>
local data = {
keymaps = M.keymaps(),
}
local core = require("lazy.core.plugin").Spec.new({ import = "lazyvim.plugins" })
---@type string[]
local plugins = {
"<details><summary>Core Plugins</summary>",
"",
Docs.plugins(core.plugins).content,
"",
"</details>",
"",
}
Util.walk(root .. "/lua/lazyvim/plugins/extras", function(path, name, type)
if type == "file" and name:find("%.lua$") then
local modname = path:gsub(".*/lua/", ""):gsub("/", "."):gsub("%.lua$", "")
local spec = require("lazy.core.plugin").Spec.new({ import = modname })
spec:fix_disabled()
vim.list_extend(plugins, {
("<details><summary>Extras: <code>%s</code></summary>"):format(modname:gsub(".*extras%.", "")),
"",
([[
To use this, add it to your **lazy.nvim** imports:
```lua
require("lazy").setup({
spec = {
{ "folke/LazyVim", import = "lazyvim.plugins" },
{ import = "%s" },
{ import = "plugins" },
},
})
```
]]):format(modname),
Docs.plugins(spec.plugins).content,
"",
"</details>",
"",
})
end
end)
data.plugins = { content = table.concat(plugins, "\n") }
Docs.save(data)
end
M.update()