[mini.pick:grep] Treesitter highlight

[drowning-cat]

Related:

• [mini.pick] Syntax/treesitter highlight #2152

This is a proof of concept:

Caution

This code relies on snacks.nvim. Don’t use it.

Caution

No match highlighting.
No caching.

Note

Doesn’t highlight multiline if statements in Lua.

if true then
end

(don't use)

vim.pack.add({
  { src = "https://github.com/nvim-mini/mini.nvim" },
  { src = "https://github.com/folke/snacks.nvim" },
  { src = "https://github.com/folke/tokyonight.nvim" },
  { src = "https://github.com/nvim-treesitter/nvim-treesitter", version = "main" },
})

vim.cmd.colorscheme("tokyonight")

-- require("nvim-treesitter").install({ "lua" })
-- vim.api.nvim_create_autocmd("FileType", {
--   desc = "Setup treesitter for a buffer",
--   pattern = { "lua" },
--   group = vim.api.nvim_create_augroup("ts_setup", { clear = true }),
--   callback = function(e)
--     vim.treesitter.start(e.buf)
--   end,
-- })

require("mini.pick").setup()
vim.keymap.set("n", "<Space>sg", ":Pick grep_live<CR>", { desc = "Search grep" })

local H = require("snacks.picker.util.highlight")
local get_highlights = function(code, ft, offset)
  local highlights = H.get_highlights({ code = code, ft = ft })[1]
  for _, hl in ipairs(highlights) do
    hl.col = hl.col + offset
    hl.end_col = hl.end_col + offset
  end
  return highlights
end

local ns = vim.api.nvim_create_namespace("pick_grep")
MiniPick.default_show_ts = function(buf_id, data, query, opts)
  vim.api.nvim_buf_clear_namespace(buf_id, ns, 0, -1)
  local items = {}
  local lines = {}
  for _, dt in ipairs(data) do
    local file, row, col, code = unpack(vim.split(dt, "%z"))
    local ft = vim.filetype.match({ filename = file })
    local prepend = string.format("%s:%d:%d ", file, row, col)
    local highlights = {}
    local row_start, row_end = string.find(prepend, row, #file + 1)
    local col_start, col_end = string.find(prepend, col, row_end + 1)
    vim.list_extend(highlights, {
      { col = row_start - 1, end_col = row_end, hl_group = "Conceal", priority = 100 },
      { col = col_start - 1, end_col = col_end, hl_group = "Added", priority = 100 },
    })
    vim.list_extend(highlights, get_highlights(code, ft, #prepend))
    local item = {
      text = prepend .. code,
      highlights = highlights,
    }
    table.insert(items, item)
    table.insert(lines, item.text)
  end
  vim.api.nvim_buf_set_lines(buf_id, 0, -1, true, lines)
  for i, item in ipairs(items) do
    for _, extm in ipairs(item.highlights) do
      local row, col = i - 1, extm.col
      extm.col = nil
      local ok, err = pcall(vim.api.nvim_buf_set_extmark, buf_id, ns, row, col, extm)
      if not ok then
        vim.notify(err, vim.log.levels.ERROR)
      end
    end
  end
end

MiniPick.registry.grep_live = function(local_opts, opts)
  return MiniPick.builtin.grep_live(
    local_opts,
    vim.tbl_deep_extend("keep", opts or {}, {
      source = {
        show = MiniPick.default_show_ts,
      },
    })
  )
end

If mini.nvim had a function similar to H.get_highlights from snacks.nvim, adding syntax highlighting to the grep picker would be relatively easy. It could be under misc or extra.

Am I missing something? Is there already a way to do so?

[pkazmier]

Loosely related is the discussion here: #988

[echasnovski]

Thanks for sharing!

This code relies on snacks.nvim. Don’t use it.

To be perfectly honest, if an advice is to not use it, then here is probably not the best place to post.

If mini.nvim had a function similar to H.get_highlights from snacks.nvim, adding syntax highlighting to the grep picker would be relatively easy. It could be under misc or extra.

I think the correct place for this kind of thing is Neovim core. I think there would be an interest in having some variant of this under vim.treesitter. But only if somebody is willing to go through making a issue+PR on top of back-and-fourth discussions about scope/implementation.

---

Also, couple of quick notes:

• Please, don't recommend solutions that monkey-patch global MiniXxx tables. The MiniPick.default_show_ts can be local default_show_ts.
• If you share useful code snippets here, please make them as minimal and 'mini.nvim' related as possible. For example, there is no need to install 'tokyonight.nvim' in the example. Probably, the same goes for 'nvim-treesitter' (just a mention of set up tree-sitter highlighting is enough).

[drowning-cat]

Fair enough, sorry about that. I didn’t mean it as an implementation, but I get that others might see it that way. The code was only meant to show one possible way to solve the problem, but it seems you're not interested in adding the feature until it's part of the core. So I might update it later with a simplified version of the snacks.nvim function.

[echasnovski]

... but it seems you're not interested in adding the feature until it's part of the core.

Yeah, I'd really like to not have to deal with not trivial use of tree-sitter or LSP. These proved to add too much of a maintenance burden. So if there is a relatively straightforward and robust way via vim.treesitter helper, it might be reasonable to have another look.

[drowning-cat]

From the start, I wanted to make two posts: this one, and a 'Show and Tell' later if the feature doesn't exist and won’t become part of mini.nvim in the future. So it makes sense to close the discussion.