中文 | English | Wiki

高速度的 Vim/Nvim 补全插件

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')）

所有命令:

全局配置：

两种方法安装 lsp 服务.

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

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

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

• :InstallLspServer
• :InstallLspServer lua

所有支持的语言:

更多 lsp 服务相关信息:

• JavaScript & TypeScript:依赖 tsserver.
• Python: 两个 python-language-server 分支可用:
  • pyls 支持 python 3.5 ~ 3.10 (pyls breaks autocomplete on Python 3.11), pip3 install python-language-server
  • pylsp 支持 python 3.11, pip3 install python-lsp-server, (推荐)
• Go: gopls. (go get golang.org/x/tools/gopls)
• Vim Script: vimls.
• C++/C/OC：Clangd.
• CSS: cssls. (css-languageserver)，Css-languageserver 要想支持 CompletionProvider，必须依赖 Snippets，需要提前手动安装.
• JSON: json-languageserver.
• PHP: intelephense
• Dart: dartls
• HTML: html. html-languageserver 要想支持 CompletionProvider. 必须手动安装 Snippets.
• Shell: bashls.
• Java: jdtls, 依赖 java 11 以及更高版本.
• Cmake: cmake.
• Kotlin: kotlin language server.
• Rust: rust-analyzer. 请用 mason 安装 lsp。
• Lua: sumneko lua. 本地配置文件路径 ~/.config/vim-easycomplete/servers/lua/config.json. 更多信息.
• Xml: lemminx.
• Groovy: groovyls.
• Yaml: yamlls.
• Ruby: solargraph.
• Nim: nimlsp. packages.json 下载非常慢, 最好手动安装，执行choosenim，参照 文档.
• Deno: denols. 使用 :DenoCache 命令来缓存当前 ts/js file.
• C# : omnisharp.
• R: r-languageserver.
• zig: zls required.
• docker: 安装插件 easycomplete-docker, 依赖 dockerfile-language-server.
• TabNine: TabNine

自定义增加某种 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"}
    }
}

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 补全提醒。有这几种方案：

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.

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

阿里巴巴工程师，无脑使用 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” 等样式。

更多例子: 例子

→ 参照文档

MIT