nvim-cmp 自定义补全菜单显示样式指南

nvim-cmp 作为 Neovim 生态中强大的自动补全插件，提供了高度可定制的补全菜单显示功能。本文将详细介绍如何通过配置来修改补全项的类型标识（Kind）和来源标识（Source），实现个性化的显示效果。

理解补全项的显示结构

在 nvim-cmp 的补全菜单中，每个条目通常包含三个主要部分：

1. 补全文本内容
2. 类型标识（Kind） - 表示补全项的类型，如函数、变量等
3. 来源标识（Source） - 表示补全的来源，如 LSP、代码片段等

自定义类型标识显示

类型标识默认使用完整的英文单词（如 "Property"），但我们可以通过配置将其简化为缩写形式（如 "Prop"）。这需要在 formatting.format 函数中实现：

local kind_items = {
  Text = "文本",
  Method = "方法",
  Function = "函数",
  Property = "属性",
  -- 其他类型...
}

require("cmp").setup({
  formatting = {
    format = function(entry, vim_item)
      vim_item.kind = kind_items[vim_item.kind] or vim_item.kind
      return vim_item
    end
  }
})

自定义来源标识显示

来源标识默认显示为源名称（如 "nvim_lsp"），我们可以将其转换为更友好的形式：

formatting = {
  format = function(entry, vim_item)
    vim_item.menu = ({
      nvim_lsp = "[LSP]",
      luasnip = "[片段]",
      buffer = "[缓冲区]"
    })[entry.source.name] or ""
    return vim_item
  end
}

完整配置示例

结合上述两种自定义方式，下面是一个完整的配置示例：

local kind_items = {
  Text = "文本",
  Method = "方法",
  Function = "函数",
  Constructor = "构造器",
  Field = "字段",
  Variable = "变量",
  Class = "类",
  Interface = "接口",
  Module = "模块",
  Property = "属性",
  Unit = "单位",
  Value = "值",
  Enum = "枚举",
  Keyword = "关键字",
  Snippet = "片段",
  Color = "颜色",
  File = "文件",
  Reference = "引用",
  Folder = "文件夹",
  EnumMember = "枚举成员",
  Constant = "常量",
  Struct = "结构体",
  Event = "事件",
  Operator = "操作符",
  TypeParameter = "类型参数"
}

require("cmp").setup({
  formatting = {
    format = function(entry, vim_item)
      -- 自定义类型标识
      vim_item.kind = kind_items[vim_item.kind] or vim_item.kind
      
      -- 自定义来源标识
      vim_item.menu = ({
        nvim_lsp = "[LSP]",
        luasnip = "[片段]",
        buffer = "[缓冲区]",
        path = "[路径]"
      })[entry.source.name] or ""
      
      return vim_item
    end
  }
})