Neovim 的 Aider 插件
这是一个简单的 Neovim 插件,允许你在 Neovim 内部打开一个终端窗口并运行 Aider。我将其作为一个使用 Aider 的实验来编写,Aider 是迄今为止我见过的最好的 AI 编码助手,现在只需在 vim 中按几个按键就可以使用。
安装
你可以使用各种包管理器来安装 Neovim 的 Aider 插件。以下是一些常见包管理器的安装说明:
使用 packer.nvim
use 'joshuavial/aider.nvim'
使用 vim-plug
Plug 'joshuavial/aider.nvim'
使用 dein
call dein#add('joshuavial/aider.nvim')
使用方法
Neovim 的 Aider 插件提供了 AiderOpen
和 AiderBackground
两个 lua 函数。
AiderOpen
函数打开一个带有 Aider 命令的终端窗口。它接受以下参数:
args
:传递给aider
的命令行参数 - 默认为 ""window_type
:要使用的窗口样式,'vsplit'(默认)、'hsplit' 或 'editor'
注意:如果 Aider 作业已经在运行,调用 AiderOpen 将重新连接到它,即使它被调用时使用了不同的标志
AiderBackground
函数在后台运行 Aider 命令。它接受以下参数:
args
:传递给aider
的命令行参数 - 默认为 ""message
:传递给 Aider 命令的消息 - 默认为 "完成尽可能多的待办事项,并删除你完成的任何项目的注释。"
当 Aider 打开时(通过任一函数),它会自动将所有打开的缓冲区添加到两个命令中。如果你要使用这个插件,你需要积极管理打开的缓冲区,使用诸如 :ls
和 :bd
之类的命令。
以下是使用 AiderOpen
和 AiderBackground
函数的一些示例:
:lua AiderOpen()
:lua AiderOpen("-3", "hsplit")
:lua AiderOpen("AIDER_NO_AUTO_COMMITS=1 aider -3", "editor")
:lua AiderBackground()
:lua AiderBackground("-3")
:lua AiderBackground("AIDER_NO_AUTO_COMMITS=1 aider -3")
你还可以在 Lua 中为 AiderOpen
和 AiderBackground
函数设置键绑定。这里有一个例子:
-- 为 AiderOpen 函数设置键绑定
vim.api.nvim_set_keymap('n', '<leader>oa', '<cmd>lua AiderOpen()<cr>', {noremap = true, silent = true})
-- 为 AiderBackground 函数设置键绑定
vim.api.nvim_set_keymap('n', '<leader>ob', '<cmd>lua AiderBackground()<cr>', {noremap = true, silent = true})
在这个例子中,在普通模式下按 <leader>oa
将调用 AiderOpen
函数,而 <leader>ob
将调用 AiderBackground
函数。
运行 aider --help
查看可以传递给 cli 的所有选项。
该插件提供以下默认键绑定:
<leader><Space><Space>
使用 Aider 默认设置(gpt-4)打开终端窗口。<leader><Space>3
使用 gpt-3.5-turbo-16k 模型进行聊天,打开带有 Aider 命令的终端窗口。<leader><space>b
在后台运行 Aider 命令,使用默认设置。<leader><space>b3
在后台运行 Aider 命令,使用 gpt-3.5-turbo-16k 模型进行聊天。
设置
Neovim 的 Aider 插件提供了一个 setup
函数,你可以用它来配置插件。这个函数接受一个包含以下键的表:
auto_manage_context
:一个布尔值,决定插件是否应该自动管理上下文。如果设置为true
,插件将在缓冲区打开和关闭时自动添加和删除缓冲区。默认为true
。default_bindings
:一个布尔值,决定插件是否应该使用默认键绑定。如果设置为true
,插件将需要键绑定文件并设置默认键绑定。默认为true
。
以下是如何使用 setup
函数的示例:
require('aider').setup({
auto_manage_context = false,
default_bindings = false
})
在这个例子中,setup
函数被调用,传入一个表,将 auto_manage_context
设置为 false
,将 default_bindings
设置为 false
。这意味着插件不会自动管理上下文,也不会使用默认键绑定。
aider_background_status
插件暴露了一个名为 aider_background_status
的全局变量,你可以用它来检查 Aider 后台进程的状态。这里有一个片段,它将创建一个 A,根据后台进程是否正在运行来改变颜色。
lualine_x = {{
function()
return 'A'
end,
color = { fg = '#8FBCBB' }, -- 绿色
cond = function()
return _G.aider_background_status == 'idle'
end
},
{
function()
return 'A'
end,
color = { fg = '#BF616A' }, -- 红色
cond = function()
return _G.aider_background_status == 'working'
end
}
}
重新加载缓冲区
因为 AiderOnBufferOpen 命令绑定到 BufReadPost,所以每当使用 :e!
重新加载缓冲区时,它都会触发。下面的 ReloadBuffer 函数将防止每次打开文件时将其添加到 aider。
function ReloadBuffer()
local temp_sync_value = vim.g.aider_buffer_sync
vim.g.aider_buffer_sync = 0
vim.api.nvim_exec2('e!', {output = false})
vim.g.aider_buffer_sync = temp_sync_value
end
要使用这个函数,只需调用 :lua ReloadBuffer()
(或将其绑定到你喜欢的快捷键)。这将刷新当前缓冲区并显示 Aider 做出的任何更改。
Vim 中使用缓冲区的技巧
如果你不熟悉 Vim 中的缓冲区,这里有一些技巧:
- 使用
:ls
或:buffers
查看所有打开的缓冲区。 - 使用
:b <number>
或:buffer <number>
切换到特定的缓冲区。用缓冲区号码替换<number>
。 - 使用
:bd
或:bdelete
关闭当前缓冲区。 - 使用
:bd <number>
或:bdelete <number>
关闭特定的缓冲区。用缓冲区号码替换<number>
。 - 使用
:bufdo bd
关闭所有缓冲区。
这个辅助函数可能对关闭所有隐藏的缓冲区有用:
_G.close_hidden_buffers = function()
local curr_buf_num = vim.api.nvim_get_current_buf()
local all_buf_nums = vim.api.nvim_list_bufs()
for _, buf_num in ipairs(all_buf_nums) do
if buf_num ~= curr_buf_num and vim.api.nvim_buf_is_valid(buf_num) and vim.api.nvim_buf_is_loaded(buf_num) and vim.fn.bufwinnr(buf_num) == -1 then
if vim.fn.getbufvar(buf_num, '&buftype') ~= 'terminal' then
vim.api.nvim_buf_delete(buf_num, { force = true })
end
end
end
end
注意
如果你调整分割窗口的大小,nvim 缓冲区可能会截断文本输出,chatGPT 告诉我这没有简单的解决方法。如果你认为不需要重新架构并使用 tmux 或类似的东西就能轻松解决,欢迎提交 PR。