rest.nvim v3 版本迁移指南与常见问题解决

rest.nvim 是一个强大的 Neovim 插件，用于发送 HTTP 请求并查看响应结果。随着 v3 版本的发布，许多用户在进行迁移时遇到了配置问题。本文将详细介绍如何从旧版本迁移到 v3，并解决常见的格式化问题。

配置方式的变化

v3 版本仍然支持两种配置方式，但配置结构发生了较大变化：

1. 通过 require("rest-nvim").setup() 函数配置
2. 通过设置 vim.g.rest_nvim 全局变量

这两种方式在功能上是等价的。例如，以下两种配置效果相同：

-- 方式一
require("rest-nvim").setup({
    env = {
        pattern = "%.env$"
    }
})

-- 方式二
vim.g.rest_nvim = {
    env = {
        pattern = "%.env$"
    }
}

主要变更点

1. 环境变量配置简化：env_edit_command 选项已被移除，现在可以使用 Telescope 的默认键位来选择如何打开 .env 文件

2. 结果窗口控制：现在所有窗口打开命令都支持 Vim 的命令修饰符

   • 使用 :tab Rest open 在新标签页打开
   • 使用 :horizontal Rest open 在水平分割窗口打开

3. 格式化机制变更：v3 使用 Neovim 内置的格式化功能（gq 命令）来格式化响应内容

常见问题解决方案

JSON 响应不格式化

这是迁移后最常见的问题。解决方案有以下几种：

1. 使用 jq 工具（推荐）：

   vim.api.nvim_create_autocmd("FileType", {
       pattern = "json",
       callback = function(ev)
           vim.bo[ev.buf].formatexpr = ""
           vim.bo[ev.buf].formatprg = "jq"
       end,
   })
   

2. 使用 LSP 格式化：

   vim.api.nvim_create_autocmd("FileType", {
       pattern = "json",
       callback = function(ev)
           vim.bo[ev.buf].formatexpr = "v:lua.vim.lsp.formatexpr()"
       end,
   })
   

注意：LSP 方式可能因为语言服务器附加到缓冲区需要时间而导致格式化不及时。

结果窗口布局控制

v3 版本通过命令修饰符控制窗口布局：

• :tab Rest run - 在新标签页运行并显示结果
• :horizontal Rest run - 在水平分割窗口运行并显示结果
• :vertical Rest run - 在垂直分割窗口运行并显示结果

环境变量问题

如果遇到 URL 编码异常的问题，请检查：

1. .env 文件中的变量是否正确定义
2. 确保没有多余的引号或特殊字符
3. 变量引用语法是否正确（{{变量名}}）

最佳实践建议

1. 对于 JSON 格式化，推荐使用 jq 工具而非 LSP，因为：

   • 响应速度更快
   • 不依赖语言服务器连接
   • 配置更简单可靠

2. 对于常用请求，可以创建快捷键组合：

   vim.keymap.set("n", "<leader>rr", "<cmd>Rest run<CR>", { desc = "运行请求" })
   vim.keymap.set("n", "<leader>rl", "<cmd>Rest run last<CR>", { desc = "运行上次请求" })
   vim.keymap.set("n", "<leader>rt", "<cmd>tab Rest run<CR>", { desc = "在新标签页运行请求" })
   

3. 对于团队项目，建议将常用请求保存在项目根目录的 .http 文件中，便于共享和版本控制。

通过以上调整，用户可以顺利迁移到 rest.nvim v3 版本，并继续享受高效的 API 测试体验。