mirror of
https://github.com/LazyVim/LazyVim.git
synced 2025-07-24 12:44:49 +02:00
chore: removed util.build. This is now part of the lazyvim website code
This commit is contained in:
Folke Lemaitre
parent
a866c6801d
commit
b68311eb6d
1 changed files with 0 additions and 376 deletions
|
|
@ -1,376 +0,0 @@
|
|||
-- Ugly code to generate some things for the readme
|
||||
local Docs = require("lazy.docs")
|
||||
local Util = require("lazy.util")
|
||||
|
||||
local M = {}
|
||||
local root = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":p:h:h:h:h")
|
||||
|
||||
---@return ReadmeBlock
|
||||
function M.keymaps()
|
||||
local keymap_set = vim.keymap.set
|
||||
---@type table<string,{mode?:string|string[], keys:string, desc?:string, i:number, group:string}>
|
||||
local keymaps = {}
|
||||
---@type string
|
||||
local group = nil
|
||||
---@type string[]
|
||||
local groups = {}
|
||||
local function map(mode, lhs, rhs, opts)
|
||||
if not (opts and opts.desc) then
|
||||
return
|
||||
end
|
||||
if not vim.tbl_contains(groups, group) then
|
||||
groups[#groups + 1] = group
|
||||
end
|
||||
mode = mode == nil and { "n", "v", "o" } or type(mode) == "string" and { mode } or mode
|
||||
local desc = opts and opts.desc or ""
|
||||
local key = lhs .. desc .. group
|
||||
if keymaps[key] then
|
||||
vim.list_extend(keymaps[key].mode, mode)
|
||||
else
|
||||
keymaps[key] = { mode = mode, keys = lhs, desc = desc, i = vim.tbl_count(keymaps), group = group }
|
||||
end
|
||||
end
|
||||
vim.keymap.set = map
|
||||
|
||||
group = "General"
|
||||
dofile(root .. "/lua/lazyvim/config/keymaps.lua")
|
||||
group = "LSP"
|
||||
local lsp = dofile(root .. "/lua/lazyvim/plugins/lsp/keymaps.lua")
|
||||
for _, keys in ipairs(lsp.get()) do
|
||||
map(keys.mode or "n", keys[1], keys[2], keys)
|
||||
end
|
||||
vim.keymap.set = keymap_set
|
||||
|
||||
group = "Plugins"
|
||||
|
||||
local core = require("lazy.core.plugin").Spec.new({ import = "lazyvim.plugins" }, { optional = true })
|
||||
Util.foreach(core.plugins, function(name, plugin)
|
||||
group = ("[%s](%s)"):format(plugin.name, plugin.url)
|
||||
for _, key in ipairs(plugin.keys or {}) do
|
||||
if type(key) == "table" and key.desc then
|
||||
local desc = key.desc or ""
|
||||
map(key.mode or "n", key[1], key[2], { desc = desc })
|
||||
end
|
||||
end
|
||||
end)
|
||||
|
||||
Util.walk(root .. "/lua/lazyvim/plugins/extras", function(path, name, t)
|
||||
if t == "file" and name:find("%.lua$") then
|
||||
local modname = path:gsub(".*/lua/", ""):gsub("/", "."):gsub("%.lua$", "")
|
||||
local extra_doc = "/plugins/extras/" .. modname:gsub("lazyvim%.plugins%.extras%.", "")
|
||||
local extra = require("lazy.core.plugin").Spec.new({ import = modname }, { optional = true })
|
||||
Util.foreach(extra.plugins, function(name, plugin)
|
||||
group = ("[%s](%s)\nPart of [%s](%s)"):format(plugin.name, plugin.url, modname, extra_doc)
|
||||
for _, key in ipairs(plugin.keys or {}) do
|
||||
if type(key) == "table" and key.desc then
|
||||
local desc = key.desc or ""
|
||||
map(key.mode or "n", key[1], key[2], { desc = desc })
|
||||
end
|
||||
end
|
||||
end)
|
||||
end
|
||||
end)
|
||||
|
||||
---@type string[]
|
||||
local lines = {}
|
||||
|
||||
for _, group in ipairs(groups) do
|
||||
lines[#lines + 1] = "## " .. group
|
||||
lines[#lines + 1] = ""
|
||||
vim.list_extend(lines, { "| Key | Description | Mode |", "| --- | --- | --- |" })
|
||||
local mappings = vim.tbl_filter(function(m)
|
||||
return m.group == group and m.desc
|
||||
end, keymaps)
|
||||
|
||||
table.sort(mappings, function(a, b)
|
||||
return a.i < b.i
|
||||
end)
|
||||
|
||||
for _, m in ipairs(mappings) do
|
||||
lines[#lines + 1] = "| <code>"
|
||||
.. m.keys:gsub(">", ">"):gsub("<", "<"):gsub("|", "|")
|
||||
.. "</code> | "
|
||||
.. m.desc
|
||||
.. " | "
|
||||
.. table.concat(
|
||||
vim.tbl_map(function(mode)
|
||||
return "**" .. mode .. "**"
|
||||
end, m.mode),
|
||||
", "
|
||||
)
|
||||
.. " |"
|
||||
end
|
||||
lines[#lines + 1] = ""
|
||||
end
|
||||
return { content = table.concat(lines, "\n") }
|
||||
end
|
||||
|
||||
function M.general()
|
||||
local lines = {
|
||||
[[
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
]],
|
||||
} ---@type string[]
|
||||
for _, entry in ipairs({
|
||||
{ name = "options", title = "Options" },
|
||||
{ name = "keymaps", title = "Keymaps" },
|
||||
{ name = "autocmds", title = "Auto Commands" },
|
||||
}) do
|
||||
local name, title = entry.name, entry.title
|
||||
lines[#lines + 1] = "## " .. title
|
||||
vim.list_extend(lines, {
|
||||
"",
|
||||
"<Tabs>",
|
||||
([[<TabItem value="custom" label="Custom %s">]]):format(title),
|
||||
"",
|
||||
([[```lua title="lua/config/%s.lua"
|
||||
%s
|
||||
```]]):format(
|
||||
name,
|
||||
Util.read_file(vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/config/" .. name .. ".lua", ":p"))
|
||||
),
|
||||
"",
|
||||
"</TabItem>",
|
||||
([[<TabItem value="defaults" label="Default %s">]]):format(title),
|
||||
"",
|
||||
([[```lua title="lazyvim.config.%s"
|
||||
%s
|
||||
```]]):format(name, Util.read_file(vim.fn.fnamemodify(root .. "/lua/lazyvim/config/" .. name .. ".lua", ":p"))),
|
||||
"",
|
||||
"</TabItem>",
|
||||
"</Tabs>",
|
||||
"",
|
||||
})
|
||||
end
|
||||
return { content = table.concat(lines, "\n") }
|
||||
end
|
||||
|
||||
function M.recipes()
|
||||
local src = Util.read_file(vim.fs.normalize("~/projects/lazyvim.github.io/lua/recipes.lua"))
|
||||
local lines = vim.split(src, "\n")
|
||||
local ret = {}
|
||||
local header = {} ---@type string[]
|
||||
local block = {} ---@type string[]
|
||||
for _, line in ipairs(lines) do
|
||||
local comment = line:match("^ %-%- ?(.*)")
|
||||
if comment then
|
||||
header[#header + 1] = comment
|
||||
elseif line:find("^ {") then
|
||||
block = { "{" }
|
||||
elseif line:find("^ }") then
|
||||
block[#block + 1] = " }"
|
||||
vim.list_extend(ret, header)
|
||||
ret[#ret + 1] = "\n```lua"
|
||||
local code = Docs.fix_indent(table.concat(block, "\n"))
|
||||
ret[#ret + 1] = code
|
||||
ret[#ret + 1] = "```\n"
|
||||
header = {}
|
||||
block = {}
|
||||
else
|
||||
block[#block + 1] = line
|
||||
end
|
||||
end
|
||||
return { content = table.concat(ret, "\n") }
|
||||
end
|
||||
|
||||
function M.update2()
|
||||
local docs = vim.fs.normalize("~/projects/lazyvim.github.io/docs")
|
||||
|
||||
local config = Docs.extract("lua/lazyvim/config/init.lua", "\nlocal defaults = ({.-\n})")
|
||||
|
||||
Docs.save({
|
||||
config = config,
|
||||
}, docs .. "/configuration/index.md")
|
||||
|
||||
Docs.save({
|
||||
general = M.general(),
|
||||
}, docs .. "/configuration/general.md")
|
||||
|
||||
Docs.save({
|
||||
recipes = M.recipes(),
|
||||
}, docs .. "/configuration/recipes.md")
|
||||
|
||||
Docs.save({
|
||||
lazy = {
|
||||
content = [[```lua title="lua/config/lazy.lua"]] .. "\n" .. Util.read_file(
|
||||
vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/config/lazy.lua", ":p")
|
||||
) .. "\n```",
|
||||
},
|
||||
}, docs .. "/configuration/lazy.nvim.md")
|
||||
|
||||
Docs.save({
|
||||
keymaps = M.keymaps(),
|
||||
}, docs .. "/keymaps.md")
|
||||
|
||||
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 lines = {} ---@type string[]
|
||||
vim.list_extend(lines, {
|
||||
"",
|
||||
([[
|
||||
To use this, add it to your **lazy.nvim** imports:
|
||||
|
||||
```lua title="lua/config/lazy.lua" {4}
|
||||
require("lazy").setup({
|
||||
spec = {
|
||||
{ "LazyVim/LazyVim", import = "lazyvim.plugins" },
|
||||
{ import = "%s" },
|
||||
{ import = "plugins" },
|
||||
},
|
||||
})
|
||||
```
|
||||
]]):format(modname),
|
||||
M.plugins("extras/" .. path:gsub(".*/extras/", "")).content,
|
||||
"",
|
||||
})
|
||||
Docs.save({
|
||||
plugins = { content = table.concat(lines, "\n") },
|
||||
}, docs .. "/plugins/extras/" .. modname:gsub(".*extras%.", "") .. ".md")
|
||||
end
|
||||
end)
|
||||
|
||||
local examples = vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/plugins/example.lua", ":p")
|
||||
Docs.save({
|
||||
examples = Util.read_file(examples):gsub("^[^\n]+\n[^\n]+\n[^\n]+\n", ""),
|
||||
}, docs .. "/configuration/examples.md")
|
||||
|
||||
Docs.save({
|
||||
plugins = M.plugins("lsp/init.lua"),
|
||||
}, docs .. "/plugins/lsp.md")
|
||||
|
||||
for _, p in ipairs({ "coding", "colorscheme", "editor", "treesitter", "ui", "util" }) do
|
||||
Docs.save({
|
||||
plugins = M.plugins(p .. ".lua"),
|
||||
}, docs .. "/plugins/" .. p .. ".md")
|
||||
end
|
||||
end
|
||||
|
||||
function M.plugins(path)
|
||||
local test = root .. "/lua/lazyvim/plugins/" .. path
|
||||
local spec = require("lazy.core.plugin").Spec.new(dofile(test), { optional = true })
|
||||
local source = Util.read_file(test)
|
||||
local parser = vim.treesitter.get_string_parser(source, "lua")
|
||||
|
||||
---@type {code: string, opts: string, name: string, comment?:string, url: string}[]
|
||||
local plugins = {}
|
||||
|
||||
local function get_text(node)
|
||||
return Docs.fix_indent(vim.treesitter.get_node_text(node, source))
|
||||
end
|
||||
|
||||
local function get_field(node, field)
|
||||
for child in node:iter_children() do
|
||||
if child:type() == "field" then
|
||||
local name_node = child:field("name")[1]
|
||||
if name_node and get_text(name_node) == field then
|
||||
return child:field("value")[1]
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local function find_plugins(node)
|
||||
if node:type() == "string" then
|
||||
local text = vim.treesitter.get_node_text(node, source):sub(2, -2)
|
||||
if text:find("/") and #node:parent():field("name") == 0 then
|
||||
local plugin_node = node:parent():parent()
|
||||
local first_child = plugin_node:named_child(0)
|
||||
if first_child and first_child:field("value")[1] and first_child:field("value")[1]:id() ~= node:id() then
|
||||
plugin_node = node
|
||||
end
|
||||
local comment_node = plugin_node:parent():prev_named_sibling()
|
||||
if comment_node and comment_node:type() ~= "comment" then
|
||||
comment_node = nil
|
||||
end
|
||||
|
||||
local opts_node = get_field(plugin_node, "opts")
|
||||
|
||||
local name_node = get_field(plugin_node, "name")
|
||||
local name = name_node and get_text(name_node):sub(2, -2) or text:match("/(.*)$")
|
||||
|
||||
if spec.plugins[name] then
|
||||
plugins[#plugins + 1] = {
|
||||
name = name,
|
||||
url = "https://github.com/" .. text,
|
||||
code = get_text(plugin_node),
|
||||
comment = comment_node and get_text(comment_node) or nil,
|
||||
opts = opts_node and get_text(opts_node) or get_field(plugin_node, "config") and "{}" or nil,
|
||||
}
|
||||
end
|
||||
end
|
||||
end
|
||||
for child in node:iter_children() do
|
||||
find_plugins(child)
|
||||
end
|
||||
end
|
||||
|
||||
parser:parse()
|
||||
-- if path ~= "extras/vscode.lua" then
|
||||
parser:for_each_tree(function(tree)
|
||||
local node = tree:root()
|
||||
find_plugins(node)
|
||||
-- print(vim.treesitter.query.get_node_text(node, str))
|
||||
end)
|
||||
-- end
|
||||
|
||||
---@type string[]
|
||||
local lines = {
|
||||
[[
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
]],
|
||||
}
|
||||
|
||||
for _, plugin in ipairs(plugins) do
|
||||
lines[#lines + 1] = "## [" .. plugin.name .. "](" .. plugin.url .. ")"
|
||||
|
||||
if plugin.comment then
|
||||
lines[#lines + 1] = ""
|
||||
lines[#lines + 1] = table.concat(
|
||||
vim.tbl_map(function(line)
|
||||
return line:gsub("^%-+", "")
|
||||
end, vim.split(plugin.comment, "\n")),
|
||||
"\n"
|
||||
)
|
||||
lines[#lines + 1] = ""
|
||||
end
|
||||
vim.list_extend(lines, {
|
||||
"",
|
||||
"<Tabs>",
|
||||
})
|
||||
vim.list_extend(lines, {
|
||||
"",
|
||||
[[<TabItem value="opts" label="Options">]],
|
||||
"",
|
||||
"```lua",
|
||||
"opts = " .. (plugin.opts or "nil"),
|
||||
"```",
|
||||
"",
|
||||
"</TabItem>",
|
||||
"",
|
||||
})
|
||||
vim.list_extend(lines, {
|
||||
"",
|
||||
[[<TabItem value="code" label="Full Spec">]],
|
||||
"",
|
||||
"```lua",
|
||||
plugin.code,
|
||||
"```",
|
||||
"",
|
||||
"</TabItem>",
|
||||
"",
|
||||
})
|
||||
vim.list_extend(lines, {
|
||||
"</Tabs>",
|
||||
"",
|
||||
})
|
||||
end
|
||||
return { content = table.concat(lines, "\n") }
|
||||
end
|
||||
-- M.extract_opts("neovim/nvim-lspconfig")
|
||||
|
||||
M.update2()
|
||||
|
||||
return M
|
||||
Loading…
Add table
Add a link
Reference in a new issue