Vim-EasyComplete

November 14, 2025 · View on GitHub

中文 | English | Wiki

高速度的 Vim/Nvim 补全插件

rust badge

What

Vim-easycomplete 是一个快速极简的自动补全插件，兼容 vim 和 neovim，支持 Linux 和 MacOS. 配置简单。vim 中基于 vimscript 实现，nvim 中基于 lua 实现，并给 MacOS 系统编译了 rust 版本，以获得更快的速度。

包含特性:

  • 兼容 vim/nvim
  • 高性能，核心算法基于 rust
  • 支持 lsp. 通过单命令安装 LSP 服务。
  • 支持关键词和字典
  • 代码片段的补全
  • 基于 TabNine 的 AI 补全助手
  • 命令行补全

安装

Vim 8.2 及以上版本，Neovim 0.7.0 及以上，支持 MacOS/Linux/FreeBSD。

lua 配置（基于 Packer.nvim ），通过 require("easycomplete").config(opt) 配置:

use { 'jayli/vim-easycomplete', requires = {'L3MON4D3/LuaSnip'}}
-- snippet 可选方案还有 'SirVer/ultisnips'
-- `tabnine_enable = 0` 等同于 `vim.g.easycomplete_tabnine_enable = 0`
require("easycomplete").config({
    cmdline = 1,
    pum_noselect = 0,
    tabnine_enable = 0,
    nerd_font = 1,
    enable = 1,
    winborder = 1,
    ghost_text = 1,
    menu_abbr = 0,
    pum_format = {"abbr", "kind", "menu"},
    setup = function()
      vim.keymap.set('n', 'gr', ':EasyCompleteReference<CR>')
      vim.keymap.set('n', 'gd', ':EasyCompleteGotoDefinition<CR>')
      vim.keymap.set('n', 'rn', ':EasyCompleteRename<CR>')
      -- Plugin has already bind shift-k to `:EasyCompleteHover`
      -- vim.keymap.set('n', 'gh', ':EasyCompleteHover<CR>')
      vim.keymap.set('n', 'gb', ':BackToOriginalBuffer<CR>')
    end
  })

执行 :PackerInstall

完整配置

还可以通过全局变量的方式来配置，这段lua配置和上面这段代码作用完全一样：

-- lua
use { 'jayli/vim-easycomplete', requires = {'L3MON4D3/LuaSnip'}}
-- 代码片段方案可选 'SirVer/ultisnips'，兼容 vim/nvim
-- Tabnine AI 补全支持, 默认值 1
-- 安装 tabnine ":InstallLspServer tabnine"
vim.g.easycomplete_tabnine_enable = 1
-- Tabnine 代码行内提醒，默认值 0
vim.g.easycomplete_tabnine_suggestion = 0
-- 使用 Nerdfont，默认值 0
vim.g.easycomplete_nerd_font = 1
-- Add window border for pum, default is 1 (for nvim 0.11 or higher)
-- 窗口边框，默认值 1，只支持 nvim 0.11 及更高版本
vim.g.easycomplete_winborder = 1
-- 匹配项格式, 默认值 {"abbr", "kind", "menu"}
vim.g.easycomplete_pum_format = {"kind", "abbr", "menu"}
-- 最常用的 keymap 配置
vim.keymap.set('n', 'gr', ':EasyCompleteReference<CR>')
vim.keymap.set('n', 'gd', ':EasyCompleteGotoDefinition<CR>')
vim.keymap.set('n', 'rn', ':EasyCompleteRename<CR>')
-- 插件默认绑定 shift-k 至 `:EasyCompleteHover`
-- vim.keymap.set('n', 'gh', ':EasyCompleteHover<CR>')
vim.keymap.set('n', 'gb', ':BackToOriginalBuffer<CR>')

-- cmdline 补全
vim.g.easycomplete_cmdline = 1

-- 关闭 pum 菜单
-- vim.keymap.set('i', '<C-M>', '<Plug>EasycompleteClosePum')

-- 重新定义 Tab/s-tab 建（选择上一个和下一个）
-- vim.g.easycomplete_tab_trigger = "<C-J>"
-- vim.g.easycomplete_shift_tab_trigger = "<C-K>"

-- 重新定义回车键
-- vim.g.easycomplete_use_default_cr = 0
-- vim.keymap.set('i', '<C-L>', '<Plug>EasycompleteCR')

执行 :PackerInstall

在非 lua 中，可以使用 viml 配置，Vimscript 配置（基于vim-plug）:

" vim
Plug 'jayli/vim-easycomplete'
Plug 'L3MON4D3/LuaSnip'
" 代码片段方案可选'SirVer/ultisnips'
" Tabnine AI 补全支持, 默认值 1
" 安装 Tabnine ":InstallLspServer tabnine"
let g:easycomplete_tabnine_enable = 1
" Tabnine 行内提醒，默认值 0
let g:easycomplete_tabnine_suggestion = 0
" Using nerdfont for lsp icons, default is 0
" 使用 Nerdfont，默认值 0
let g:easycomplete_nerd_font = 1
" 窗口边框，默认值 1，（只支持 nvim 0.11 及更高版本）
let g:easycomplete_winborder = 1
" 匹配项格式，默认值 ["abbr", "kind", "menu"]
let g:easycomplete_pum_format = ["kind", "abbr", "menu"]
" 最常用的 keymap 配置
noremap gr :EasyCompleteReference<CR>
noremap gd :EasyCompleteGotoDefinition<CR>
noremap rn :EasyCompleteRename<CR>
" 插件默认绑定 shift-k 至 `:EasyCompleteHover`
" noremap gh :EasyCompleteHover<CR>
noremap gb :BackToOriginalBuffer<CR>

" cmdline 补全
let g:easycomplete_cmdline = 1

" 关闭 pum 菜单
" inoremap <C-M> <Plug>EasycompleteClosePum

" 选择上一个和下一个的快捷键
" let g:easycomplete_tab_trigger = "<C-J>"
" let g:easycomplete_shift_tab_trigger = "<C-K>"

" 重新定义回车键
" let g:easycomplete_use_default_cr = 0
" inoremap <C-L> <Plug>EasycompleteCR

执行 :PlugInstall.

一个例子.

使用

输入过程中自动显示匹配菜单，并通过 Tab 来选择下一个匹配项，Shift-Tab 选择上一个匹配项。Ctrl-] 跳转到定义处，Ctrl-t跳回（和 tags 跳转快捷键一致）。

使用Ctrl-N/Shift-Ctrl-N 跳转到下一个/上一个错误提示位置。Ctrl-E关闭匹配菜单。

其他可选配置：

  • 建议：set updatetime=150 (lua: vim.opt.updatetime = 150).
  • 默认设置 noselected：setlocal completeopt+=noselect（lua: vim.cmd('setlocal completeopt+=noselect')）

命令

所有命令:

命令说明
:EasyCompleteInstallServer安装当前文件所属的 LSP 服务
:InstallLspServer同 EasyCompleteInstallServer
:EasyCompleteDisable禁用插件
:EasyCompleteEnable启用插件
:EasyCompleteGotoDefinition跳转到定义
:EasyCompleteReference跳转到引用
:EasyCompleteRename重命名
:EasyCompleteHover查看更多信息
:EasyCompleteCheck检查 LSP 是否安装
:EasyCompletePreviousDiagnostic跳转到上一个错误提示
:EasyCompleteNextDiagnostic跳转到下一个错误提示
:EasyCompleteProfileStart性能check起始时刻
:EasyCompleteProfileStop性能check结束时刻，并生成 profile.log
:EasyCompleteLint语法检查
:LintEasyComplete语法检查
:BackToOriginalBuffer返回引用跳转前最初的位置
:DenoCache拉取 Deno 文件依赖文件并缓存
:CleanLog关闭跳转文件列表窗口

全局配置：

全局变量默认值说明
g:easycomplete_rust_enable1在MacOS_x86平台下开启 rust 高性能模式
g:easycomplete_nerd_font0使用 nerdfont
g:easycomplete_menu_skin{}菜单图标配置.
g:easycomplete_kind_icons{}Kind 图标.
g:easycomplete_sign_text{}提示图标配置.
g:easycomplete_lsp_type_font...lsp 图标配置
g:easycomplete_lsp_server{}给特定的源使用 不同的 lsp server
g:easycomplete_tabnine_suggestion0Tabnine 行内补全(for nvim only)
g:easycomplete_lsp_checking1打开文件时是否立即检查 lsp 是否安装
g:easycomplete_tabnine_enable1启用 Tabnine：启用后补全菜单里会出现 Tabnine 补全项
g:easycomplete_path_enable1目录匹配
g:easycomplete_snips_enable1代码片段匹配
g:easycomplete_tabnine_config{}TabNine 配置
g:easycomplete_filetypes{}自定义文件类型配置
g:easycomplete_enable1是否启用插件
g:easycomplete_tab_trigger<Tab>触发并选择下一项的按键
g:easycomplete_shift_tab_trigger<S-Tab>选择上一项的按键
g:easycomplete_cursor_word_hl0光标停留处的单词高亮
g:easycomplete_signature_offset0错误提示的偏移量
g:easycomplete_diagnostics_next<C-N>跳转到下一个错误提示
g:easycomplete_diagnostics_prev<S-C-n>跳转到上一个错误提示
g:easycomplete_diagnostics_enable1启用语法检查
g:easycomplete_signature_enable1启用函数参数说明提醒
g:easycomplete_diagnostics_hover1光标停住所在行显示错误提醒
g:easycomplete_winborder1窗口边框 (支持 nvim 0.11 和更高版本)
g:easycomplete_pum_border_style"rounded"Pum 边框样式
g:easycomplete_info_border_style"single"辅助信息边框样式
g:easycomplete_ghost_text1幽灵文本
g:easycomplete_pum_maxheight20补全窗口最大高度
g:easycomplete_pum_fix_width1pum 窗口是否固定宽度
g:easycomplete_pum_format["abbr", "kind", "menu"]匹配项格式
g:easycomplete_menu_abbr0匹配菜单里menu字段是否显示简写，否则显示全称
g:easycomplete_custom_snippet""自定义 snippets 路径
g:easycomplete_use_default_cr1是否使用默认回车的事件绑定
g:easycomplete_pum_pretty_style1开启 border 时自适应 pum 样式
g:easycomplete_cmdline1cmdline 匹配
g:easycomplete_pum_maxlength31匹配列表单词最长的字符数
g:easycomplete_pum_noselect0是否不自动选中第一个匹配项. 同 set &completeopt+=noselect

语言支持

两种方法安装 lsp 服务.

  1. 同时支持vim/nvim: :InstallLspServer.
  2. 只支持nvim: 基于 mason.nvim, 执行 :MasonInstall {lsp-server-name}

LSP 服务会安装在本地路径： ~/.config/vim-easycomplete/servers。

执行InstallLspServer命令时可以带上（语言）插件名称，也可以不带，下面两种都可以：

  • :InstallLspServer
  • :InstallLspServer lua

所有支持的语言:

名称语言LSP 服务LSP 是否需要安装依赖URL
pathpathNo Need内置无
bufbuf & dictNo Need内置无
snipsSnippetsultisnips/LuaSnip内置python3/lua
tsjs/tstsserverYesnode/npm
denojs/tsdenolsYesdeno
tnTabNineTabNineYes无
vimVimvimlsYesnode/npm
cppC/C++/OCclangdYes无
cssCSScsslsYesnode/npm
htmlHTMLhtmlYesnode/npm
ymlYAMLyamllsYesnode/npm
xmlXmllemminxYesjava/jdk
shBashbashlsYesnode/npm
jsonJSONjson-languageserverYesnode/npm
phpphpintelephenseYesnode/npm
dartdartdartlsYes无
pyPythonpylspYespython3/pip3
javaJavajdtlsYesjava11/jdk
goGogoplsYesgo
rRr-languageserverYesR
rbRubysolargraphYesruby/bundle
luaLuasumneko_luaYesLua
nimNimnimlspYesnim/nimble
rustRustrust_analyzerYes无
ktKotlinkotlin_language_serverYesjava/jdk
grvyGroovygroovylsYesjava/jdk
cmakecmakecmakeYespython3/pip3
c#C#omnisharp-lspYes无
zigzigzlsYeszig
dockerdockerdockerfile-language-serverMasonnode/npmeasycomplete-docker

更多 lsp 服务相关信息:

自定义增加某种 lsp 所支持的语言类型，通常情况下不需要这么做：

vimscript

" vim
let g:easycomplete_filetypes = {
      \   "sh": {
      \     "whitelist": ["shell"]
      \   },
      \   "r": {
      \     "whitelist": ["rmd", "rmarkdown"]
      \   },
      \ }

luascript

-- lua
vim.g.easycomplete_filetypes = {
    sh = {
        whitelist = {"shell"}
    },
    r = {
        whitelist = {"rmd", "rmarkdown"}
    }
}

Snippets 代码片段支持

Vim-Easycomplete 的代码片段支持依赖 ultisnips 或 LuaSnip。只需在依赖字段中引用进来即可。性能考虑，推荐优先使用 L3MON4D3/LuaSnip（只支持 nvim），兼容考虑使用 SirVer/ultisnips（支持 vim/nvim）。 你可以增加 snippets 目录到 &runtimepath 中。

你可以设置自己的 snippets 路径：

vimscript

" vim
let g:easycomplete_custom_snippet = "./path/to/your/snippets"

luascript

-- lua
vim.g.easycomplete_custom_snippet = "./path/to/your/snippets"

AI 编程助手

除了补全菜单中包含 AI 建议项之外，插件还支持行内 AI 补全提醒。有这几种方案：

1）Tabnine

Vim-easycomplete 默认支持 Tabnine。Tabnine 是本地运算补全结果的比较好的选择（最新版已经更新至 deep-tabnine，只支持云端补全），速度考虑，插件只支持了 Tabnine 的本地补全的版本。

安装 :InstallLspServer tabnine.

配置Tabnine: g:easycomplete_tabnine_config，两个配置:

  • line_limit: 参与计算的行数. 越小速度越快，越大补全更准. (默认: 1000)
  • max_num_result: 在补全菜单中显示几个推荐项. (默认: 3)

vimscript

" vim
let g:easycomplete_tabnine_config = {
    \ 'line_limit': 1000,
    \ 'max_num_result' : 3,
    \ }

luascript

-- lua
vim.g.easycomplete_tabnine_config = {
    line_limit = 1000,
    max_num_result = 3
}

TabNine 不使用 APIKey 就可以运行。如果你是 Tabnine 的付费用户，可以配置 API key 获得行内补全的增强。通过在文件中敲入魔术字符Tabnine::config来激活配置面板。文档

启用 Tabnine 的行内补全: let g:easycomplete_tabnine_suggestion = 1.

2) copilot.nvim

Tabnine 虽然运行速度快且稳定，但比较古老，行内补全推荐使用 Copilot.nvim

3) Aone Copilot

阿里巴巴工程师，无脑使用 Aone Copilot，速度和质量都很高，ATA 上搜一下就有用 copilot.nvim 的配置方法。

补全菜单的定制

使用 g:easycomplete_nerd_font = 1 来支持 Nerdfont 字体. 图标配置方法参照 Examples.

You can add custom Pmenu styles by defining these highlight groups:

补全菜单的样式定义：

  • EasyFuzzyMatch: 匹配字符高亮. 默认 link 到 "PmenuMatch"
  • EasyPmenu: Pmenu 菜单样式. 默认 link 到 "Pmenu".
  • EasyPmenuKind: PmenuKind 样式. 默认 link 到 "PmenuKind".
  • EasyPmenuExtra: PmenuExtra 样式. 默认link到 "PmenuExtra".
  • EasyFunction: Function 图标样式. 默认link到 "Conditional".
  • EasySnippet: Snippet 图标样式. 默认link到 "Keyword".
  • EasyTabNine: TabNine 图标样式. 默认link到 "Character".
  • EasySnippets: 行内补全样式. 默认link到 "LineNr"
  • EasyNormal: 默认图标样式，默认link到 Normal.
  • EasyKeyword: 默认Keyword图标，默认links 到 "Define".
  • EasyModule: 默认Module 图标. 默认links到"Function".

当 g:easycomplete_winborder 设置为 1. Pmenu 匹配菜单的背景色会自动设置成和文档背景色一致。如果你不想被自动设置 pum 背景色，可以这样关掉: let g:easycomplete_pum_pretty_style = 0，然后定义新的“Pmenu, FloatBorder, PmenuExtra, PmenuKind” 等样式。

更多例子: 例子

截屏2023-12-30 20 25 06

开发新的语言插件

→ 参照文档

License

MIT