NeoAI

NeoAI 是一个 Neovim 插件，它将 OpenAI 的 GPT-4 的强大功能直接带入你的编辑器。它帮助你生成代码、重写文本，甚至根据上下文获取建议。该插件构建了用户友好的界面，使得与 AI 交互并获得所需帮助变得容易。

注意： 此插件正处于早期变更阶段，并且可能会发生变化。

动机

本插件背后的主要动机是将 AI 聊天助手（如 ChatGPT）无缝集成到你的 Neovim 编码工作流中。目标是创建一个与你和谐工作的工具，让你能够提问并获得帮助，而不会打断你的专注力或编码节奏。与大多数优先考虑娱乐而非生产力的现有插件不同，本插件强调效率和实用性。通过促进流畅且响应迅速的编码体验，旨在提高生产力并使编码更加愉快。

安装

要安装 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,
}

对于 packer：

use ({
    "Bryley/neoai.nvim",
    require = { "MunifTanjim/nui.nvim" },
    cmd = {
        "NeoAI",
        "NeoAIOpen",
        "NeoAIClose",
        "NeoAIToggle",
        "NeoAIContext",
        "NeoAIContextOpen",
        "NeoAIContextClose",
        "NeoAIInject",
        "NeoAIInjectCode",
        "NeoAIInjectContext",
        "NeoAIInjectContextCode",
    },
    config = function()
        require("neoai").setup({
            -- Options go here
        })
    end,
})

展示与使用

要使用此插件，请确保你拥有 OpenAI API（应用程序编程接口）密钥，可以在 这里 创建。将此密钥保存到你的环境变量 OPENAI_API_KEY 中。

重要提示：本插件不对意外进行的 OpenAI 购买负责。使用此插件时，我建议你经常检查账户的 使用情况 并 设置限制，以免花费超出承受能力的金额。

本插件引入了 3 种模式或与 AI 模型交互的方式。

普通 GUI 模式

在默认模式下，使用 :NeoAI 命令会在侧边打开一个 GUI（图形用户界面），允许你与模型聊天。此操作类似于在浏览器中使用时的体验，但现在由于 GUI 位于编辑器内而变得更加方便。

在 Prompt Buffer（提示缓冲区）中，你可以在插入模式下按 Enter 发送文本。此外，可以使用 Control Enter 插入换行符。此映射可以在配置中更改。

另外请注意，该插件有一个功能，即模型的输出会自动保存到 g 寄存器，所有代码片段都会保存到 c 寄存器。这些可以在配置中更改。

上下文模式

上下文模式的工作原理与普通模式类似。但是，你有能力提供关于你想要更改内容的额外信息。例如，如果你正在阅读他人的代码并需要描述其作用，可以通过 visual 模式（可视模式）高亮显示缓冲区中的代码。然后，运行 :NeoAIContext 并在提示缓冲区中输入类似“请为我解释这段代码”的内容。

此外，你可以高亮一些文本并要求“修复这段文本的标点和语法”，以获得更好的文本版本。

请注意，如果在不选择任何内容的情况下运行命令，则整个缓冲区将被传递进去。

注入模式

最后一种模式被称为“注入模式”，通过使用 :NeoAIInject 启用。此模式在没有图形用户界面的情况下运行，允许你快速向模型发送提示，并将生成的输出自动插入到光标下方。所有这些都可以在不打开 GUI 的情况下完成。此外，注入模式内还有一个可以结合上下文执行的子模式。

快捷键

本插件的一个功能是创建快捷键，如下所述。该插件包含两个内置快捷键；第一个重新格式化选定的文本以提高可读性，默认键位绑定为 <leader>as（A 代表 AI，S 代表总结）。

另一个内置快捷键是为你自动生成 git 提交信息：

警告：请注意，过度使用此功能可能会导致发送给模型的数据积累，从而导致高昂的费用。为了避免这种情况，建议进行较小的提交或较少频率地使用此功能。跟踪使用情况至关重要，可以通过 此链接 进行监控。

设置

要设置此插件，请将以下代码（使用默认值）添加到你的 init.lua 文件中（如果使用 lazy.nvim 或 packer.nvim，请将其放入 config 选项下）。

require("neoai").setup({
    -- Below are the default options, feel free to override what you would like changed
    ui = {
        output_popup_text = "NeoAI",
        input_popup_text = "Prompt",
        width = 30, -- As percentage eg. 30%
        output_popup_height = 80, -- As percentage eg. 80%
        submit = "<Enter>", -- Key binding to submit the prompt
    },
    models = {
        {
            name = "openai",
            model = "gpt-3.5-turbo",
            params = nil,
        },
    },
    register_output = {
        ["g"] = function(output)
            return output
        end,
        ["c"] = require("neoai.utils").extract_code_snippets,
    },
    inject = {
        cutoff_width = 75,
    },
    prompts = {
        context_prompt = function(context)
            return "Hey, I'd like to provide some context for future "
                .. "messages. Here is the code/text that I want to refer "
                .. "to in our upcoming conversations:\n\n"
                .. context
        end,
    },
    mappings = {
        ["select_up"] = "<C-k>",
        ["select_down"] = "<C-j>",
    },
    open_ai = {
        api_key = {
            env = "OPENAI_API_KEY",
            value = nil,
            -- `get` is is a function that retrieves an API key, can be used to override the default method.
            -- get = function() ... end

            -- Here is some code for a function that retrieves an API key. You can use it with
            -- the Linux 'pass' application.
            -- get = function()
            --     local key = vim.fn.system("pass show openai/mytestkey")
            --     key = string.gsub(key, "\n", "")
            --     return key
            -- end,
        },
    },
    shortcuts = {
        {
            name = "textify",
            key = "<leader>as",
            desc = "fix text with AI",
            use_context = true,
            prompt = [[
                Please rewrite the text to make it more readable, clear,
                concise, and fix any grammatical, punctuation, or spelling
                errors
            ]],
            modes = { "v" },
            strip_function = nil,
        },
        {
            name = "gitcommit",
            key = "<leader>ag",
            desc = "generate git commit message",
            use_context = false,
            prompt = function()
                return [[
                    Using the following git diff generate a consise and
                    clear git commit message, with a short title summary
                    that is 75 characters or less:
                ]] .. vim.fn.system("git diff --cached")
            end,
            modes = { "n" },
            strip_function = nil,
        },
    },
})

选项

设置函数接受一个包含选项的表 (table) 来配置插件。可用选项如下：

UI (用户界面) 选项

• output_popup_text: 输出弹窗窗口上显示的标题文本（默认："NeoAI"）。
• input_popup_text: 输入弹窗窗口上显示的标题文本（默认："Prompt"）。
• width: 窗口宽度的百分比（例如，30 = 30%，默认：30）。
• output_popup_height: 输出弹窗高度的百分比（例如，80 = 80%，默认：80）。
• submit: 提交提示词的按键绑定。如果设置为 ， 将被映射为插入新行。（默认：""）。

模型选项

• models: 要使用的模型列表：
  • name: 模型提供商的名称（例如："openai"）
  • model: 要使用的模型名称字符串或模型名称列表
  • params: 传递给模型的参数表（例如 temperature, top_p）

寄存器输出

• register_output: 一个以寄存器为键的表，以及一个接受 AI 原始输出并决定保存到该寄存器的内容的函数。示例：

register_output = {
    ["g"] = function(output)
        return output
    end,
    ["c"] = require("neoai.utils").extract_code_snippets,
}

注入选项

• cutoff_width: 当注入时，如果文本长度超过此值，应换行。如果设置为 nil，则忽略长度（默认：75）。

提示词选项

• context_prompt: 一个生成用于上下文模式 (Context modes) 的提示词的函数。示例：

context_prompt = function(context)
    return "Hi ChatGPT, I'd like to provide some context for future "
        .. "messages. Here is the code/text that I want to refer "
        .. "to in our upcoming conversations:\n\n"
        .. context
end

OpenAI 选项:

• open_api_key_env (已弃用，请使用 api_key.env 代替): 包含 OpenAI API 密钥的环境变量。默认值为 "OPENAI_API_KEY "。
• api_key.env: 包含 OpenAI API 密钥的环境变量。默认值为 "OPENAI_API_KEY"。
• api_key.value: OpenAI API 密钥，其优先级高于 api_key .env。
• api_key.get: 用于检索 OpenAI API 密钥的函数。有关实现示例，请参阅 设置 部分。它具有更高的优先级。

映射

• mappings: 包含以下操作的表，这些操作可以作为键：

  • select_up: 在输入窗口中选择输出窗口
  • select_down: 在输出窗口中选择输入窗口

值是这些操作的按键绑定，如果没有操作则为 nil

快捷方式选项

• shortcuts: 快捷方式数组。每个快捷方式是一个包含以下内容的表：
• name: 字符串。快捷方式的名称，可以使用 :NeoAIShortcut 触发
• key: 监听的键绑定值，如果快捷方式没有键绑定则为 nil。
• desc 字符串或 nil。按键绑定的描述（如果有）
• use_context: 是否应使用选中/缓冲区的上下文。
• prompt: 要发送的提示词或生成要发送的提示词的函数。
• modes: 设置按键绑定的模式列表，"n" 代表正常模式，"v" 代表可视模式。
• strip_function: 要使用的剥离函数（可选）。

用户命令

:NeoAI [prompt]

智能切换 NeoAI 窗口。如果窗口已关闭，它将打开并发送可选的 [prompt]。如果窗口已打开且聚焦，它将关闭。最后，如果窗口已打开但未聚焦，它将聚焦窗口并发送可选的 [prompt]。

:NeoAIToggle [prompt]

切换 NeoAI 窗口。如果窗口已关闭，它将打开并发送可选的 [prompt]。如果窗口已打开，它将关闭。

:NeoAIOpen [prompt]

打开 NeoAI 窗口并发送可选的 [prompt]。

:NeoAIClose

关闭 NeoAI 窗口。

:NeoAIContext [prompt]

智能地根据上下文 (context) 切换 NeoAI 窗口。如果窗口关闭，它将打开并发送可选的 [prompt]。如果窗口已打开且聚焦，它将关闭；最后，如果窗口已打开但未聚焦，它将聚焦该窗口并发送可选的 [prompt]。此命令使用的上下文 (context) 是可视模式下选中的文本 (visual mode)，如果没有进行选择，则为整个缓冲区 (buffer)。

:NeoAIContextOpen [prompt]

打开带有上下文 (context) 的 NeoAI 窗口并发送可选的 [prompt]。此命令使用的上下文 (context) 是可视模式下选中的文本 (visual mode)，如果没有进行选择，则为整个缓冲区 (buffer)。

:NeoAIContextClose

关闭带有上下文 (context) 的 NeoAI 窗口。

:NeoAIInject [prompt]

将 [prompt] 发送给 AI，并直接将 AI 响应注入到缓冲区 (buffer) 中，无需打开 NeoAI 窗口。

:NeoAIInjectCode [prompt]

将 [prompt] 发送给 AI，并直接将 AI 响应注入到缓冲区 (buffer) 中，无需打开 NeoAI 窗口。响应将被剥离所有非代码片段的内容。

:NeoAIInjectContext [prompt]

将 [prompt] 与上下文 (context) 一起发送给 AI，并直接将 AI 响应注入到缓冲区 (buffer) 中，无需打开 NeoAI 窗口。此命令使用的上下文 (context) 是可视模式下选中的文本 (visual mode)，如果没有进行选择，则为整个缓冲区 (buffer)。

:NeoAIInjectContextCode [prompt]

将 [prompt] 与上下文 (context) 一起发送给 AI，并直接将 AI 响应注入到缓冲区 (buffer) 中，无需打开 NeoAI 窗口。响应将被剥离所有非代码片段的内容。此命令使用的上下文 (context) 是可视模式下选中的文本 (visual mode)，如果没有进行选择，则为整个缓冲区 (buffer)。

:NeoAIShortcut <shortcut>

触发在配置中通过其名称创建的 NeoAI 快捷方式，而不是通过键绑定 (keybinding)。

Roadmap:

• 问题 1
  • 为快捷方式添加描述选项
  • 能够通过用户命令运行快捷方式
• 测试 (已开始)
• 多个聊天会话
• Telescope 集成
• 切换模型
• 更好的颜色（例如高亮用户输入）
• 在 NeoAIContext 缓冲区内部时高亮上下文，或使上下文清晰可见
• 用于用新生成的代码替换上下文的键映射
• 支持：
  • Amazon CodeWhisperer
  • Github Copilot
• 更好的错误检测
• 来回对话
• 使用可视模式 (visual mode) 的上下文
• 修复在 NeoAI 图形用户界面 (GUI) 上使用 :q 的问题
• 配置
• 为上下文相关问题添加自定义键绑定
• 合并注入操作的撤销
• 修复注入标记有时未设置注入模式的问题。
• 注入时剥离输出以获取代码或其他内容。
  • 确保也匹配文件末尾并用于注入模式
• 使用缓冲区的上下文
• 从输出中剥离代码并放入缓冲区
• 添加设置配置
• 更好地聚焦图形用户界面 (GUI) 窗口的方法

License

采用 MIT 许可证授权。有关详细信息，请查看 LICENSE 文件。

NeoAI Neovim 插件快速上手指南

环境准备

在使用 NeoAI 之前，请确保您的开发环境满足以下要求：

• Neovim: 已安装并正常运行。
• 系统依赖: 需要安装 curl 工具。
• 插件依赖: 需安装 nui.nvim。
• OpenAI 账户: 拥有有效的 OpenAI API Key。
• 环境变量: 将 API Key 保存为系统环境变量 OPENAI_API_KEY。

注意: 此插件涉及 API 调用，请注意控制使用成本，建议定期检查 OpenAI 用量 并设置账单限额。

安装步骤

您可以根据使用的插件管理器选择相应的配置方式。

使用 vim-plug

在 init.vim 或 .vimrc 中添加以下内容：

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

然后运行 :PlugInstall 进行安装。

使用 lazy.nvim

在 lua/plugins/ 下的配置文件中添加：

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,
}

使用 packer.nvim

use ({
    "Bryley/neoai.nvim",
    require = { "MunifTanjim/nui.nvim" },
    cmd = {
        "NeoAI",
        "NeoAIOpen",
        "NeoAIClose",
        "NeoAIToggle",
        "NeoAIContext",
        "NeoAIContextOpen",
        "NeoAIContextClose",
        "NeoAIInject",
        "NeoAIInjectCode",
        "NeoAIInjectContext",
        "NeoAIInjectContextCode",
    },
    config = function()
        require("neoai").setup({
            -- Options go here
        })
    end,
})

基本使用

初始化配置

在 Neovim 的配置文件（如 init.lua）中运行 setup 函数以加载默认选项或自定义配置：

require("neoai").setup({
    ui = {
        output_popup_text = "NeoAI",
        input_popup_text = "Prompt",
        width = 30, 
        output_popup_height = 80, 
        submit = "<Enter>", 
    },
    models = {
        {
            name = "openai",
            model = "gpt-3.5-turbo",
            params = nil,
        },
    },
    open_ai = {
        api_key = {
            env = "OPENAI_API_KEY",
            value = nil,
        },
    },
    -- ... 其他配置项
})

交互模式

插件提供三种主要交互模式：

1. Normal GUI Mode (普通模式)

   • 命令：:NeoAI
   • 功能：在编辑器侧边打开 GUI 窗口与 AI 聊天，类似浏览器体验。
   • 输入：按 Enter 发送消息，Ctrl + Enter 换行。

2. Context Mode (上下文模式)

   • 命令：:NeoAIContext
   • 功能：选中代码或文本后运行，AI 将基于选中的内容进行解释或修改。
   • 示例：选中一段代码，输入 "Please explain this code for me"。

3. Inject Mode (注入模式)

   • 命令：:NeoAIInject
   • 功能：无 GUI 界面，直接将 AI 生成的内容插入到光标下方。

内置快捷键

插件预设了以下快捷操作（需在配置中启用）：

• 总结文本: <leader>as (默认绑定)
• 生成 Git Commit Message: <leader>ag (默认绑定)

输出寄存器

模型输出的内容会自动保存到特定寄存器中，方便后续操作：

• g 寄存器：保存完整输出。
• c 寄存器：仅保存代码片段。