CodeCompanion.nvim自定义变量功能解析与使用指南

问题背景

在CodeCompanion.nvim项目中，用户报告了一个关于自定义聊天变量功能的问题。根据文档描述，用户可以通过配置回调函数来创建自定义变量，但在实际使用过程中遇到了类型错误，导致功能无法正常工作。

问题本质

核心问题在于变量回调函数的处理机制存在缺陷。当用户按照文档配置如下回调函数时：

variables = {
    ["git diff"] = {
        callback = function()
            return string.format([[```diff\n%s\n```]], 
                vim.fn.system("git diff --no-ext-diff HEAD"))
        end
    }
}

系统期望接收字符串类型输入，但实际上接收到了函数类型，导致vim/shared.lua模块在尝试分割字符串时抛出类型错误。

技术解决方案

项目维护者通过提交修复了这一问题。修复的核心在于正确处理回调函数的执行和返回值：

1. 确保变量解析流程能够正确识别并执行回调函数
2. 将回调函数的返回值作为字符串处理
3. 完善变量系统的类型检查机制

正确配置方式

修复后，用户可以采用以下方式配置自定义变量：

require("codecompanion").setup({
    strategies = {
        chat = {
            variables = {
                ["git diff"] = {
                    callback = function()
                        -- 确保返回字符串内容
                        local diff = vim.fn.system("git diff --no-ext-diff HEAD")
                        return string.format("```diff\n%s\n```", diff)
                    end,
                    description = "向LLM分享当前git差异",
                    opts = {
                        contains_code = true,
                        hide_reference = true
                    }
                }
            }
        }
    }
})

功能扩展建议

基于此功能，开发者可以进一步扩展：

1. 多变量组合：创建组合多个git命令的复合变量
2. 条件变量：根据当前工作区状态返回不同的内容
3. 缓存机制：对耗时操作的结果进行缓存，提高响应速度

最佳实践

1. 始终在回调函数中进行错误处理，确保返回有效的字符串
2. 对于复杂操作，考虑添加加载状态提示
3. 合理使用opts配置控制变量行为
4. 为自定义变量编写清晰的描述文档

总结

CodeCompanion.nvim的自定义变量功能为开发者提供了强大的扩展能力。通过本次修复，该功能变得更加稳定可靠。开发者现在可以安全地创建各种动态内容变量，与LLM进行更丰富的交互。建议用户更新到最新版本以获得最佳体验。