Trouble.nvim：Neovim 代码问题管理专家-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00023/article/details/148487353

Trouble.nvim：Neovim 代码问题管理专家

trouble.nvim 🚦 A pretty diagnostics, references, telescope results, quickfix and location list to help you solve all the trouble your code is causing. 项目地址: https://gitcode.com/gh_mirrors/tr/trouble.nvim

概述

Trouble.nvim 是一款专为 Neovim 设计的现代化问题管理插件，它能够以美观且结构化的方式展示代码中的各种问题信息。无论是诊断错误、LSP 引用、快速修复列表还是位置列表，Trouble.nvim 都能帮助开发者高效地识别和处理代码问题。

核心特性

全面支持的问题类型

诊断信息：集成 Neovim 的诊断系统
LSP 相关：支持定义、引用、实现、类型定义、文档符号等
调用关系：展示函数/方法的入向和出向调用
传统列表：兼容 quickfix 和 location list
搜索结果：支持 Telescope 和 fzf-lua 的搜索结果展示

高级功能亮点

多窗口并行：可同时打开多个 Trouble 窗口
智能跟随：自动跟踪光标所在项
树形视图：按自然层次结构展示项目（如文档符号）
高度可配置：支持自定义格式化器、过滤器和排序器
状态栏组件：可作为状态栏组件显示当前文档符号
预览功能：支持自动预览当前选中项

安装指南

环境要求

Neovim ≥ 0.9.2 版本
正确配置的 LSP 客户端
可选：nvim-web-devicons（用于文件图标）
推荐：支持图标显示的字体

安装步骤

使用你偏好的包管理器安装插件。以下是使用 Lazy.nvim 的配置示例：

{
  "folke/trouble.nvim",
  opts = {}, -- 默认配置
  cmd = "Trouble",
  keys = {
    { "<leader>xx", "<cmd>Trouble diagnostics toggle<cr>", desc = "诊断(Trouble)" },
    { "<leader>xX", "<cmd>Trouble diagnostics toggle filter.buf=0<cr>", desc = "缓冲区诊断" },
    { "<leader>cs", "<cmd>Trouble symbols toggle focus=false<cr>", desc = "文档符号" },
    { "<leader>cl", "<cmd>Trouble lsp toggle focus=false win.position=right<cr>", desc = "LSP定义/引用" },
    { "<leader>xL", "<cmd>Trouble loclist toggle<cr>", desc = "位置列表" },
    { "<leader>xQ", "<cmd>Trouble qflist toggle<cr>", desc = "快速修复列表" },
  },
}

配置详解

Trouble.nvim 提供了丰富的配置选项，以下是关键配置说明：

窗口行为

auto_close：无项目时自动关闭
auto_open：有项目时自动打开
focus：打开时聚焦窗口
follow：跟随当前光标项
pinned：将窗口绑定到当前缓冲区

显示设置

indent_guides：显示缩进参考线
multiline：显示多行信息
max_items：每部分最大显示项数

键位映射

插件预定义了丰富的键位映射，例如：

<cr>：跳转并关闭窗口
<c-s>：分割窗口跳转
dd：删除当前项
zo/zc：展开/折叠
自定义动作示例：按严重程度过滤

模式配置

可以自定义各种显示模式，如：

调整 LSP 引用模式参数
自定义文档符号过滤器
扩展基础 LSP 模式

使用技巧

常用命令

" 切换当前缓冲区诊断（不聚焦窗口）
:Trouble diagnostics toggle focus=false filter.buf=0

" 在右侧显示文档符号（保持同步）
:Trouble symbols toggle pinned=true win.position=right

" 仅显示错误级别诊断
:Trouble diagnostics filter.severity=vim.diagnostic.severity.ERROR

高级用法

使用 Lua 表达式作为过滤条件
嵌套选项合并配置
字符串参数引号可选

可用模式

diagnostics：诊断信息
loclist：位置列表
lsp_*：各类 LSP 信息
qflist：快速修复列表
symbols：文档符号
telescope/fzf：搜索结果

API 参考

Trouble.nvim 提供了完整的 Lua API：

-- 基本操作
require("trouble").open(mode)  -- 打开指定模式
require("trouble").close()     -- 关闭
require("trouble").toggle()    -- 切换

-- 状态查询
require("trouble").is_open()   -- 检查是否打开
require("trouble").get_items() -- 获取当前项

-- 状态栏集成
require("trouble").statusline() -- 创建状态栏组件

-- 视图操作
require("trouble").first()     -- 跳转首项
require("trouble").filter()    -- 应用过滤
require("trouble").fold_*()    -- 各种折叠操作