neovim

help.lua (5698B)

---

-- use treesitter over syntax (for highlighted code blocks)
vim.treesitter.start()

--- Apply current colorscheme to lists of default highlight groups
---
--- Note: {patterns} is assumed to be sorted by occurrence in the file.
--- @param patterns {start:string,stop:string,match:string}[]
local function colorize_hl_groups(patterns)
 local ns = vim.api.nvim_create_namespace('nvim.vimhelp')
 vim.api.nvim_buf_clear_namespace(0, ns, 0, -1)

 local save_cursor = vim.fn.getcurpos()

 for _, pat in pairs(patterns) do
   local start_lnum = vim.fn.search(pat.start, 'c')
   local end_lnum = vim.fn.search(pat.stop)
   if start_lnum == 0 or end_lnum == 0 then
     break
   end

   for lnum = start_lnum, end_lnum do
     local word = vim.api.nvim_buf_get_lines(0, lnum - 1, lnum, true)[1]:match(pat.match)
     if vim.fn.hlexists(word) ~= 0 then
       vim.api.nvim_buf_set_extmark(0, ns, lnum - 1, 0, { end_col = #word, hl_group = word })
     end
   end
 end

 vim.fn.setpos('.', save_cursor)
end

-- Add custom highlights for list in `:h highlight-groups`.
local bufname = vim.fs.normalize(vim.api.nvim_buf_get_name(0))
if vim.endswith(bufname, '/doc/syntax.txt') then
 colorize_hl_groups({
   { start = [[\*group-name\*]], stop = '^======', match = '^(%w+)\t' },
   { start = [[\*highlight-groups\*]], stop = '^======', match = '^(%w+)\t' },
 })
elseif vim.endswith(bufname, '/doc/treesitter.txt') then
 colorize_hl_groups({
   {
     start = [[\*treesitter-highlight-groups\*]],
     stop = [[\*treesitter-highlight-spell\*]],
     match = '^@[%w%p]+',
   },
 })
elseif vim.endswith(bufname, '/doc/diagnostic.txt') then
 colorize_hl_groups({
   { start = [[\*diagnostic-highlights\*]], stop = '^======', match = '^(%w+)' },
 })
elseif vim.endswith(bufname, '/doc/lsp.txt') then
 colorize_hl_groups({
   { start = [[\*lsp-highlight\*]], stop = '^------', match = '^(%w+)' },
   { start = [[\*lsp-semantic-highlight\*]], stop = '^======', match = '^@[%w%p]+' },
 })
end

vim.keymap.set('n', 'gO', function()
 require('vim.treesitter._headings').show_toc()
end, { buffer = 0, silent = true, desc = 'Show an Outline of the current buffer' })

vim.keymap.set('n', ']]', function()
 require('vim.treesitter._headings').jump({ count = 1 })
end, { buffer = 0, silent = false, desc = 'Jump to next section' })
vim.keymap.set('n', '[[', function()
 require('vim.treesitter._headings').jump({ count = -1 })
end, { buffer = 0, silent = false, desc = 'Jump to previous section' })

local parser = assert(vim.treesitter.get_parser(0, 'vimdoc', { error = false }))

local function runnables()
 ---@type table<integer, { lang: string, code: string }>
 local code_blocks = {}
 local query = vim.treesitter.query.parse(
   'vimdoc',
   [[
   (codeblock
     (language) @_lang
     .
     (code) @code
     (#any-of? @_lang "lua" "vim")
     (#set! @code lang @_lang))
 ]]
 )

 local root = parser:parse()[1]:root()
 for _, match, metadata in query:iter_matches(root, 0, 0, -1) do
   for id, nodes in pairs(match) do
     local name = query.captures[id]
     local node = nodes[1]
     local start, _, end_ = node:parent():range()

     if name == 'code' then
       local code = vim.treesitter.get_node_text(node, 0)
       local lang_node = match[metadata[id].lang][1] --[[@as TSNode]]
       local lang = vim.treesitter.get_node_text(lang_node, 0)
       for i = start + 1, end_ do
         code_blocks[i] = { lang = lang, code = code }
       end
     end
   end
 end

 vim.keymap.set('n', 'g==', function()
   local pos = vim.api.nvim_win_get_cursor(0)[1]
   local code_block = code_blocks[pos]
   if not code_block then
     vim.print('No code block found')
   elseif code_block.lang == 'lua' then
     vim.cmd.lua(code_block.code)
   elseif code_block.lang == 'vim' then
     vim.cmd(code_block.code)
   end
 end, { buffer = true })
end

-- Retry once if the buffer has changed during the iteration of the code
-- blocks. See #36574.
if not pcall(runnables) then
 runnables()
end

local url_ns = vim.api.nvim_create_namespace('nvim.help.urls')
local function urls()
 local filepath = vim.fs.normalize(vim.api.nvim_buf_get_name(0))

 if vim.fs.relpath(vim.env.VIMRUNTIME, filepath) ~= nil then
   local base = 'https://neovim.io/doc/user/helptag/?tag='
   local query = vim.treesitter.query.parse(
     'vimdoc',
     [[
   ((optionlink) @helplink)
   (taglink
     text: (_) @helplink)
   (tag
     text: (_) @helplink)
   ]]
   )

   vim.api.nvim_buf_clear_namespace(0, url_ns, 0, -1)
   local root = parser:parse()[1]:root()
   for _, match, _ in query:iter_matches(root, 0, 0, -1) do
     for id, nodes in pairs(match) do
       if query.captures[id] == 'helplink' then
         for _, node in ipairs(nodes) do
           local start_line, start_col, end_line, end_col = node:range()
           local tag = vim.treesitter.get_node_text(node, 0)
           vim.api.nvim_buf_set_extmark(0, url_ns, start_line, start_col, {
             end_line = end_line,
             end_col = end_col,
             url = base .. vim.uri_encode(tag),
           })
         end
       end
     end
   end
 end
end

-- Retry once if the buffer has changed during the iteration of the code
-- blocks. See #36574.
if not pcall(urls) then
 urls()
end

vim.b.undo_ftplugin = (vim.b.undo_ftplugin or '')
 .. '\n sil! exe "nunmap <buffer> gO" | sil! exe "nunmap <buffer> g=="'
 .. '\n sil! exe "nunmap <buffer> ]]" | sil! exe "nunmap <buffer> [["'
 .. ('\n call v:lua.vim.api.nvim_buf_clear_namespace(0, %d, 0, -1)'):format(url_ns)
vim.b.undo_ftplugin = vim.b.undo_ftplugin .. ' | call v:lua.vim.treesitter.stop()'