neoai.nvim

NeoAI 介绍

NeoAI 是一款 Neovim 的插件，它将 OpenAI 的 GPT-4 强大功能直接引入到编辑器中。这款插件可以帮助用户生成代码、重写文本，并提供与代码内容相关的建议。NeoAI 拥有用户友好的界面，使得用户可以轻松与 AI 互动并获取所需的帮助。

项目动机

NeoAI 的主要动机是将 AI 聊天助手，如 ChatGPT，流畅地整合到 Neovim 的编程工作流中。其目标是创建一个与用户协同工作的工具，让用户在不打断专注或编码节奏的情况下提问和获取帮助。与市面上大多数以娱乐为主轴的插件不同，NeoAI 更注重效率和实用性，通过提供平滑且响应迅速的编码体验来提高生产力，使编程变得更加愉悦。

安装

NeoAI 可以通过用户喜爱的插件管理器安装。例如，使用 vim-plug 插件管理器，只需在 init.vim 或 .vimrc 中添加以下代码即可（注意，需要安装 nui 依赖项和 curl）：

Plug 'MunifTanjim/nui.nvim'
Plug 'Bryley/neoai.nvim'

然后运行 :PlugInstall 来安装插件。

对于 lazy.nvim 用户，可以按如下设置：

return {
    "Bryley/neoai.nvim",
    dependencies = {
        "MunifTanjim/nui.nvim",
    },
    cmd = {
        "NeoAI",
        "NeoAIOpen",
        "NeoAIClose",
        "NeoAIToggle",
        "NeoAIContext",
        "NeoAIContextOpen",
        "NeoAIContextClose",
        "NeoAIInject",
        "NeoAIInjectCode",
        "NeoAIInjectContext",
        "NeoAIInjectContextCode",
    },
    keys = {
        { "<leader>as", desc = "summarize text" },
        { "<leader>ag", desc = "generate git message" },
    },
    config = function()
        require("neoai").setup({
            -- Options go here
        })
    end,
}

使用展示

使用 NeoAI 插件之前，用户需要确保已拥有一个 OpenAI API 密钥，可以在 OpenAI 官方网站创建。将此密钥保存到环境变量中，名称为 OPENAI_API_KEY。

正常 GUI 模式

默认情况下，使用 :NeoAI 命令，GUI 会在 Neovim 的侧面打开，这使得用户可以与模型进行对话。这种操作类似于浏览器中的使用体验，但却更加方便，因为 GUI 就在用户的编辑器内。

上下文模式

与正常模式类似，上下文模式使用户可以提供额外信息，比如用户在阅读别人的代码时需要描述其用途。通过视觉模式高亮代码，然后运行 :NeoAIContext 并在提示缓冲区输入“请为我解释这段代码”。

注入模式

注入模式通过 :NeoAIInject 使用，无需打开图形用户界面即可快速发送提示到模型，并将结果输出直接插入到光标位置下方。

快捷键

NeoAI 插件拥有快捷键功能，内置了两个快捷键，如重新格式化选中文本以改善可读性，默认按键为 <leader>as；另一则是自动生成 Git 提交消息。

设置

用户可以通过在 init.lua 中添加默认值代码来设置插件，或者将其放置在 lazy.nvim 或 packer.nvim 的 config 选项下。

展望

NeoAI 的开发团队还在计划增加更多功能，比如多个聊天会话、Telescope 集成、模型切换等功能。此外，还在设想支持 Amazon CodeWhisperer 和 Github Copilot 等其他 AI 服务。

许可

NeoAI 遵循 MIT 许可证，详细信息见 LICENSE 文件。

NeoAI 不仅为 Neovim 用户带来了新的效率工具，还为编程工作流增添了一份创新与智能的色彩。无论是在代码生成中，还是简化文本处理，NeoAI 都努力帮助用户实现流畅且高效的工作体验。