mirror of
https://github.com/LazyVim/LazyVim.git
synced 2025-06-28 03:30:12 +02:00
build: ugly code for generating lazyvim.github.io :)
This commit is contained in:
Folke Lemaitre
parent
5d3e126b63
commit
354416f3d5
2 changed files with 177 additions and 71 deletions
|
|
@ -1,5 +1,5 @@
|
||||||
return {
|
return {
|
||||||
-- better vim.notify
|
-- Better `vim.notify()`
|
||||||
{
|
{
|
||||||
"rcarriga/nvim-notify",
|
"rcarriga/nvim-notify",
|
||||||
keys = {
|
keys = {
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ local Docs = require("lazy.docs")
|
||||||
local Util = require("lazy.util")
|
local Util = require("lazy.util")
|
||||||
|
|
||||||
local M = {}
|
local M = {}
|
||||||
local root = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":h:h:h:h")
|
local root = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":p:h:h:h:h")
|
||||||
|
|
||||||
---@return ReadmeBlock
|
---@return ReadmeBlock
|
||||||
function M.keymaps()
|
function M.keymaps()
|
||||||
|
|
@ -90,34 +90,68 @@ function M.keymaps()
|
||||||
return { content = table.concat(lines, "\n") }
|
return { content = table.concat(lines, "\n") }
|
||||||
end
|
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.update2()
|
function M.update2()
|
||||||
local docs = vim.fs.normalize("~/projects/lazyvim.github.io/docs")
|
local docs = vim.fs.normalize("~/projects/lazyvim.github.io/docs")
|
||||||
|
|
||||||
|
Docs.save({
|
||||||
|
general = M.general(),
|
||||||
|
}, docs .. "/configuration/general.md")
|
||||||
|
|
||||||
Docs.save({
|
Docs.save({
|
||||||
keymaps = M.keymaps(),
|
keymaps = M.keymaps(),
|
||||||
}, docs .. "/keymaps.md")
|
}, docs .. "/keymaps.md")
|
||||||
|
|
||||||
local core = require("lazy.core.plugin").Spec.new({ import = "lazyvim.plugins" })
|
|
||||||
|
|
||||||
Docs.save({
|
|
||||||
plugins = Docs.plugins(core.plugins),
|
|
||||||
}, docs .. "/plugins/index.md")
|
|
||||||
|
|
||||||
---@type string[]
|
|
||||||
local plugins = {}
|
|
||||||
|
|
||||||
Util.walk(root .. "/lua/lazyvim/plugins/extras", function(path, name, type)
|
Util.walk(root .. "/lua/lazyvim/plugins/extras", function(path, name, type)
|
||||||
if type == "file" and name:find("%.lua$") then
|
if type == "file" and name:find("%.lua$") then
|
||||||
local modname = path:gsub(".*/lua/", ""):gsub("/", "."):gsub("%.lua$", "")
|
local modname = path:gsub(".*/lua/", ""):gsub("/", "."):gsub("%.lua$", "")
|
||||||
local spec = require("lazy.core.plugin").Spec.new({ import = modname })
|
local lines = {} ---@type string[]
|
||||||
spec:fix_disabled()
|
vim.list_extend(lines, {
|
||||||
vim.list_extend(plugins, {
|
|
||||||
("## <code>%s</code>"):format(modname:gsub(".*extras%.", "")),
|
|
||||||
"",
|
"",
|
||||||
([[
|
([[
|
||||||
To use this, add it to your **lazy.nvim** imports:
|
To use this, add it to your **lazy.nvim** imports:
|
||||||
|
|
||||||
```lua
|
```lua title="lua/config/lazy.lua"
|
||||||
require("lazy").setup({
|
require("lazy").setup({
|
||||||
spec = {
|
spec = {
|
||||||
{ "folke/LazyVim", import = "lazyvim.plugins" },
|
{ "folke/LazyVim", import = "lazyvim.plugins" },
|
||||||
|
|
@ -127,77 +161,149 @@ require("lazy").setup({
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
]]):format(modname),
|
]]):format(modname),
|
||||||
Docs.plugins(spec.plugins).content,
|
M.plugins("extras/" .. path:gsub(".*/extras/", "")).content,
|
||||||
"",
|
"",
|
||||||
})
|
})
|
||||||
|
Docs.save({
|
||||||
|
plugins = { content = table.concat(lines, "\n") },
|
||||||
|
}, docs .. "/plugins/extras/" .. modname:gsub(".*extras%.", "") .. ".md")
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
Docs.save({
|
|
||||||
plugins = { content = table.concat(plugins, "\n") },
|
|
||||||
}, docs .. "/plugins/extras.md")
|
|
||||||
|
|
||||||
local examples = vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/plugins/example.lua", ":p")
|
local examples = vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/plugins/example.lua", ":p")
|
||||||
Docs.save({
|
Docs.save({
|
||||||
examples = Util.read_file(examples):gsub("^[^\n]+\n[^\n]+\n[^\n]+\n", ""),
|
examples = Util.read_file(examples):gsub("^[^\n]+\n[^\n]+\n[^\n]+\n", ""),
|
||||||
}, docs .. "/configuration/09-examples.md")
|
}, docs .. "/configuration/examples.md")
|
||||||
|
|
||||||
Docs.save({
|
Docs.save({
|
||||||
config = Docs.extract("lua/lazyvim/config/init.lua", "\nlocal defaults = ({.-\n})"),
|
plugins = M.plugins("lsp/init.lua"),
|
||||||
}, docs .. "/configuration/01-lazyvim.md")
|
}, 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
|
end
|
||||||
|
|
||||||
function M.update()
|
function M.plugins(path)
|
||||||
---@type table<string, ReadmeBlock>
|
local test = root .. "/lua/lazyvim/plugins/" .. path
|
||||||
local data = {
|
local spec = require("lazy.core.plugin").Spec.new(dofile(test))
|
||||||
keymaps = M.keymaps(),
|
local source = Util.read_file(test)
|
||||||
config = Docs.extract("lua/lazyvim/config/init.lua", "\nlocal defaults = ({.-\n})"),
|
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.query.get_node_text(node, source):sub(2, -2)
|
||||||
|
if text:find("/") and #node:parent():field("name") == 0 then
|
||||||
|
local plugin_node = node:parent():parent()
|
||||||
|
if plugin_node:named_child(0):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()
|
||||||
|
parser:for_each_tree(function(tree)
|
||||||
|
local node = tree:root()
|
||||||
|
find_plugins(node)
|
||||||
|
-- print(vim.treesitter.query.get_node_text(node, str))
|
||||||
|
end)
|
||||||
|
|
||||||
|
---@type string[]
|
||||||
|
local lines = {
|
||||||
|
[[
|
||||||
|
import Tabs from '@theme/Tabs';
|
||||||
|
import TabItem from '@theme/TabItem';
|
||||||
|
]],
|
||||||
}
|
}
|
||||||
|
|
||||||
local examples = vim.fn.fnamemodify(root .. "/../LazyVim-starter/lua/plugins/example.lua", ":p")
|
for _, plugin in ipairs(plugins) do
|
||||||
data.examples = Util.read_file(examples):gsub("^[^\n]+\n[^\n]+\n[^\n]+\n", "")
|
lines[#lines + 1] = "## [" .. plugin.name .. "](" .. plugin.url .. ")"
|
||||||
Docs.save(data)
|
|
||||||
end
|
|
||||||
|
|
||||||
function M.extract_opts(plugin)
|
if plugin.comment then
|
||||||
local code ---@type string
|
lines[#lines + 1] = ""
|
||||||
Util.lsmod("lazyvim.plugins", function(modname, modpath)
|
lines[#lines + 1] = table.concat(
|
||||||
local data = Util.read_file(modpath)
|
vim.tbl_map(function(line)
|
||||||
if data:find('"' .. plugin .. '"', 1, true) then
|
return line:gsub("^%-+", "")
|
||||||
code = data
|
end, vim.split(plugin.comment, "\n")),
|
||||||
|
"\n"
|
||||||
|
)
|
||||||
|
lines[#lines + 1] = ""
|
||||||
end
|
end
|
||||||
end)
|
vim.list_extend(lines, {
|
||||||
if not code then
|
"",
|
||||||
return
|
"<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
|
end
|
||||||
|
return { content = table.concat(lines, "\n") }
|
||||||
local lines = vim.split(code, "\n")
|
|
||||||
local found_plugin = false
|
|
||||||
local found_opts = false
|
|
||||||
local indent = 0
|
|
||||||
local opts = {} ---@type string[]
|
|
||||||
local comments = {} ---@type string[]
|
|
||||||
for _, line in ipairs(lines) do
|
|
||||||
if line:find('"' .. plugin .. '"', 1, true) then
|
|
||||||
found_plugin = true
|
|
||||||
end
|
|
||||||
if found_plugin and line:find("^%s+opts = {") then
|
|
||||||
found_opts = true
|
|
||||||
indent = #line:match("^(%s+)")
|
|
||||||
elseif found_plugin and not found_opts and line:find("^%s+%-%-") then
|
|
||||||
comments[#comments + 1] = line
|
|
||||||
elseif found_plugin and not found_opts and not line:find("^%s+%-%-") then
|
|
||||||
comments = {}
|
|
||||||
elseif found_opts and line:find("^" .. string.rep(" ", indent) .. "}") then
|
|
||||||
break
|
|
||||||
elseif found_opts then
|
|
||||||
opts[#opts + 1] = line
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
local ret = "{\n" .. Docs.indent(Docs.fix_indent(table.concat(opts, "\n")), 2) .. "\n}"
|
|
||||||
if #comments > 0 then
|
|
||||||
ret = Docs.fix_indent(table.concat(comments, "\n")) .. "\n" .. ret
|
|
||||||
end
|
|
||||||
print(ret)
|
|
||||||
end
|
end
|
||||||
-- M.extract_opts("neovim/nvim-lspconfig")
|
-- M.extract_opts("neovim/nvim-lspconfig")
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue