gen.nvim

使用可自定义提示的LLM生成文本

gen_nvim

视频

要求

Ollama，并安装合适的模型，如llama3.1、mistral等。
Curl

安装

使用你喜欢的插件管理器安装，例如lazy.nvim

使用Lazy的示例

-- 最小配置
{ "David-Kunz/gen.nvim" },

-- 自定义参数（带默认值）
{
    "David-Kunz/gen.nvim",
    opts = {
        model = "mistral", -- 默认使用的模型
        quit_map = "q", -- 设置关闭响应窗口的快捷键
        retry_map = "<c-r>", -- 设置重新发送当前提示的快捷键
        accept_map = "<c-cr>", -- 设置用最后一个结果替换先前选择的快捷键
        host = "localhost", -- 运行Ollama服务的主机
        port = "11434", -- Ollama服务监听的端口
        display_mode = "float", -- 显示模式。可以是"float"、"split"或"horizontal-split"
        show_prompt = false, -- 显示提交给Ollama的提示
        show_model = false, -- 在聊天会话开始时显示你使用的模型
        no_auto_close = false, -- 永不自动关闭窗口
        hidden = false, -- 隐藏生成窗口（如果为true，将隐式设置`prompt.replace = true`），需要Neovim >= 0.10
        init = function(options) pcall(io.popen, "ollama serve > /dev/null 2>&1 &") end,
        -- 初始化Ollama的函数
        command = function(options)
            local body = {model = options.model, stream = true}
            return "curl --silent --no-buffer -X POST http://" .. options.host .. ":" .. options.port .. "/api/chat -d $body"
        end,
        -- Ollama服务的命令。你可以使用占位符$prompt、$model和$body（shell转义）。
        -- 这也可以是一个命令字符串。
        -- 执行的命令必须返回一个包含{ response, context }的JSON对象
        -- （context属性是可选的）。
        -- list_models = '<省略的lua函数>', -- 检索模型名称列表
        debug = false -- 打印错误和运行的命令
    }
},

这里是所有可用模型。

或者，你可以调用setup函数：

require('gen').setup({
  -- 同上
})

使用方法

使用Gen命令基于预定义和可自定义的提示生成文本。

示例快捷键映射：

vim.keymap.set({ 'n', 'v' }, '<leader>]', ':Gen<CR>')

你也可以直接使用预定义提示或自定义提示调用它：

vim.keymap.set('v', '<leader>]', ':Gen Enhance_Grammar_Spelling<CR>')

一旦对话开始，整个上下文都会发送给LLM。这允许你使用以下命令问后续问题：

:Gen Chat

窗口关闭后，你将开始一个新的对话。

对于不自动替换先前选择文本的提示（replace = false），你可以使用<c-cr>用生成的输出替换选中的文本。

你可以使用以下命令从所有已安装模型的列表中选择一个模型：

require('gen').select_model()

自定义提示

所有提示都定义在require('gen').prompts中，你可以增强或修改它们。

示例：

require('gen').prompts['Elaborate_Text'] = {
  prompt = "详细阐述以下文本：\n$text",
  replace = true
}
require('gen').prompts['Fix_Code'] = {
  prompt = "修复以下代码。只输出```$filetype\n...\n```格式的结果：\n```$filetype\n$text\n```",
  replace = true,
  extract = "```$filetype\n(.-)```"
}

你可以为每个提示使用以下属性：

prompt：（字符串 | 函数）提示可以是字符串或应返回字符串的函数。结果可以使用以下占位符：
- $text：可视选择的文本或当前缓冲区的内容
- $filetype：缓冲区的文件类型（如javascript）
- $input：额外的用户输入
- $register：未命名寄存器的值（复制的文本）
replace：如果选中的文本应被生成的输出替换，则为true
extract：用于提取生成结果的正则表达式
model：要使用的模型，如zephyr，默认：mistral