snacks.nvim/lua/snacks/picker/source/grep.lua
Folke Lemaitre 3b54c8d3d1
feat(picker): add exact match position highlighting for grep results
Uses ripgrep's --replace feature to mark exact match positions with
separators (__snacks__${0}__snacks__), then parses these positions
for precise highlighting.

Benefits:
- Exact match highlighting in list, preview, and file formatter
- Works with any grep pattern (regex, fixed-string, case-insensitive)
- No need for pattern parsing or vim.regex workarounds
- Positions are provided directly by ripgrep, guaranteed accurate

Implementation:
- Added item.positions field to track match character indices
- New highlight.matches() helper for creating match extmarks
- Modified grep source to parse and extract positions from rg output
- Updated list, preview, and format to use positions when available

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-21 12:27:45 +02:00

180 lines
4.6 KiB
Lua

local M = {}
local uv = vim.uv or vim.loop
local MATCH_SEP = "__snacks__"
---@param opts snacks.picker.grep.Config
---@param filter snacks.picker.Filter
local function get_cmd(opts, filter)
local cmd = "rg"
local args = {
"--color=never",
"--no-heading",
"--with-filename",
"--line-number",
"--replace",
("%s${0}%s"):format(MATCH_SEP, MATCH_SEP),
"--column",
"--smart-case",
"--max-columns=500",
"--max-columns-preview",
"--glob=!.bare",
"--glob=!.git",
"-0",
}
args = vim.deepcopy(args)
-- exclude
for _, e in ipairs(opts.exclude or {}) do
vim.list_extend(args, { "-g", "!" .. e })
end
-- hidden
if opts.hidden then
table.insert(args, "--hidden")
else
table.insert(args, "--no-hidden")
end
-- ignored
if opts.ignored then
args[#args + 1] = "--no-ignore"
end
-- follow
if opts.follow then
args[#args + 1] = "-L"
end
local types = type(opts.ft) == "table" and opts.ft or { opts.ft }
---@cast types string[]
for _, t in ipairs(types) do
args[#args + 1] = "-t"
args[#args + 1] = t
end
if opts.regex == false then
args[#args + 1] = "--fixed-strings"
end
local glob = type(opts.glob) == "table" and opts.glob or { opts.glob }
---@cast glob string[]
for _, g in ipairs(glob) do
args[#args + 1] = "-g"
args[#args + 1] = g
end
-- extra args
vim.list_extend(args, opts.args or {})
-- search pattern
local pattern, pargs = Snacks.picker.util.parse(filter.search)
vim.list_extend(args, pargs)
args[#args + 1] = "--"
table.insert(args, pattern)
local paths = {} ---@type string[]
if opts.buffers then
for _, buf in ipairs(vim.api.nvim_list_bufs()) do
local name = vim.api.nvim_buf_get_name(buf)
if name ~= "" and vim.bo[buf].buflisted and uv.fs_stat(name) then
paths[#paths + 1] = name
end
end
end
vim.list_extend(paths, opts.dirs or {})
if opts.rtp then
vim.list_extend(paths, Snacks.picker.util.rtp())
end
-- dirs
if #paths > 0 then
paths = vim.tbl_map(svim.fs.normalize, paths) ---@type string[]
vim.list_extend(args, paths)
end
return cmd, args
end
---@param opts snacks.picker.grep.Config
---@type snacks.picker.finder
function M.grep(opts, ctx)
if opts.need_search ~= false and ctx.filter.search == "" then
return function() end
end
local absolute = (opts.dirs and #opts.dirs > 0) or opts.buffers or opts.rtp
local cwd = not absolute and svim.fs.normalize(opts and opts.cwd or uv.cwd() or ".") or nil
local cmd, args = get_cmd(opts, ctx.filter)
if opts.debug.grep then
Snacks.notify.info("grep: " .. cmd .. " " .. table.concat(args, " "))
end
return require("snacks.picker.source.proc").proc({
opts,
{
notify = false, -- never notify on grep errors, since it's impossible to know if the error is due to the search pattern
cmd = cmd,
args = args,
---@param item snacks.picker.finder.Item
transform = function(item)
item.cwd = cwd
-- Split on NUL byte (which comes from rg's -0 flag)
local file_sep = item.text:find("\0")
if not file_sep then
if not item.text:match("WARNING") then
Snacks.notify.error("invalid grep output:\n" .. item.text)
end
return false
end
local file = item.text:sub(1, file_sep - 1)
local rest = item.text:sub(file_sep + 1)
item.text = file .. ":" .. rest
---@type string?, string?, string?
local line, col, text = rest:match("^(%d+):(%d+):(.*)$")
if not (line and col and text) then
if not item.text:match("WARNING") then
Snacks.notify.error("invalid grep output:\n" .. item.text)
end
return false
end
-- indices of matches
local positions = {} ---@type number[]
local from = tonumber(col)
item.pos = { tonumber(line), from - 1 }
local offset = 0
local in_match = false
while from < #text do
local idx = text:find(MATCH_SEP, from, true)
if not idx then
break
end
if in_match then
for i = from, idx - 1 do
positions[#positions + 1] = i - offset
end
item.end_pos = item.end_pos or { item.pos[1], idx - offset - 1 }
end
in_match = not in_match
offset = offset + #MATCH_SEP
from = idx + #MATCH_SEP
end
item.file = file
if #positions > 0 then
text = text:gsub(MATCH_SEP, "")
item.positions = positions
end
item.line = text
end,
},
}, ctx)
end
return M