在fzf-lua中过滤特定类型的代码标签

fzf-lua作为Neovim中强大的模糊查找插件，为开发者提供了便捷的代码导航功能。其中tags功能允许用户快速跳转到代码中的各种定义，但在某些编程语言如C++中，可能会包含过多不必要显示的成员变量标签，影响查找效率。

问题背景

在C++开发中，使用ctags生成的标签文件包含多种类型：

• 类定义(c)
• 函数定义(f)
• 成员变量(m)
• 枚举值(e)
• 类型定义(t)等

默认情况下，fzf-lua的tags命令会显示所有类型的标签，这可能导致结果列表过长，特别是当项目中包含大量成员变量时。

解决方案

方法一：生成时过滤

最直接的方法是在生成tags文件时就排除不需要的类型：

ctags --languages=C++ --kinds-C++=-m -R .

其中-m表示排除成员变量类型。

方法二：运行时过滤

如果需要在运行时动态过滤，可以结合shell脚本和fzf-lua的自定义命令：

1. 首先确保tags文件包含行号信息：

ctags-universal --fields=+n -R .

2. 创建过滤脚本filter-tags：

#!/bin/bash
remove_tags_file_metadata='1,11d'
remove_prefix_line_number='s/line://g'
remove_kinds_z=('$4 != "z"')

cat ${1} | sed --expression "${remove_tags_file_metadata}" \
    --expression "${remove_prefix_line_number}" |
    awk "${remove_kinds_z[@]}"

3. 在Neovim配置中添加自定义命令：

local get_path_and_position = function(inputString)
    local elements = {}
    for element in string.gmatch(inputString, "[^\t]+") do
        table.insert(elements, element)
    end
    return elements
end

_G.fzf_tags = function(opts)
    opts = opts or {}
    opts.prompt = "Tags>"
    opts.preview = "bat -p --color=always {2} --highlight-line={5}"
    opts.actions = {
        ["ctrl-t"] = function(selected)
            local array = get_path_and_position(selected[1])
            vim.cmd("tabnew +" .. array[5] .. " " .. array[2])
        end,
        default = function(selected)
            local array = get_path_and_position(selected[1])
            vim.cmd("e +" .. array[5] .. " " .. array[2])
        end,
    }
    opts.fzf_opts = {
        ["--delimiter"] = "\t",
        ["--preview-window"] = "top:wrap,+{5}+3/3",
        ["--with-nth"] = "1,2,5",
    }
    if vim.fn.filereadable("tags") == 1 then
        require("fzf-lua").fzf_exec("filter-tags tags", opts)
    else
        print("No tags files here")
    end
end

vim.keymap.set("n", "<leader>pt", "<cmd>lua _G.fzf_tags()<CR>")

高级技巧

1. 预览优化：使用bat命令显示代码预览时，可以添加语法高亮和行号显示：

opts.preview = "bat -p --color=always --style=numbers {2} --highlight-line={5}"

2. 多条件过滤：在awk脚本中可以添加多个过滤条件：

remove_kinds=('$4 != "z" && $4 != "m"')

3. 动态查询：结合fzf的查询语法，可以在运行时进一步过滤结果：

opts.fzf_opts = {
    ["--query"] = "!function",  -- 排除包含"function"的结果
}

总结

通过上述方法，开发者可以根据项目需求灵活控制fzf-lua中显示的标签类型，提高代码导航效率。对于大型C++项目，合理过滤成员变量等次要标签可以显著提升开发体验。

值得注意的是，虽然fzf-lua本身不提供内置的标签类型过滤功能，但通过结合shell脚本和Lua配置，我们仍然能够实现这一需求，展现了Neovim生态的高度可定制性。