Life With Vim[2] 用Deoplete和cquery搭建代码补全

使用Deoplete作为Vim的代码补全

YouCompleteMe

从开始学习用Vim写代码起,我一直都是用的YouCompleteMe来进行补全。因为网上一搜,至少中文资源里面关于Python和C的Vim补全插件就全是说YCM。

我对YCM的感觉,谈不上坏,但也不是很好。

首先YCM用起来,至少在Mac上其实是很方便的:Vim-plug下载,进目录./install.py --clang-completer安装玩,基本上就可以开始用了。顶天在修改一下ycm_extra_conf.py让它自己去找include目录和compile_commands.json就可以了。

但不满的地方在于,这个插件有点大。这可能和它的架构有关系:它作为一个Vim插件试图去整合那些后端做静态分析的库。这导致它不管是横向还是纵向发展都很缓慢:拓展语言和拓展功能的工作量都很大。

再有就是在Arch上总有点奇奇怪怪的问题。完全不是过去开箱即用的感觉。因为插件大,看文档看的头痛。虽然最后花了半小时是用上了,但一直问自己为什么不去用VScode。

Deoplete

Deoplete其实从功能上说,和YCM是一样的。但它的实现方式就很讨喜:就是一个前端的补全引擎而已,后端的东西能分离的都尽量分离出去。就能够认清自己只是一个前端插件来说,我就很喜欢。

因为这样的分离,Deoplete从理论上来说,就没有什么语言不支持的。因为它可以自定义complete source。在Completion Sources上列出专门支持的语句就不止20种。而且最重要的是它支持LanguageClient这个插件。

LanguageClient

几周前,在Vim Subreddit上看到关于LSP(Language Server Protocol)的贴子后,就觉得这个点子好。因为各个语言的代码分析库纷繁复杂,只要LSP这个协议推广开来,各语言各自实现一个支持LSP的language server统一调用接口,那么市面上所有的编辑器都可以享用到不妥协的语言服务了(重构对于纯编辑器就简单许多)。

于是我这两天搜了一搜,果不其然Vim就已经有了LanguageClient这个插件了。

LanguageClient其实就是一个中间件,存在的原因就是因为Neovim/vim自带的和第三方的补全引擎不支持LSP。LanuageClient在中间当胖翻译就是了。

Language Servers

因为现在主要写C++,现在C/C++主要的LS就两个一个是clangd一个是cquery

clangd

  • 好处是它是clang自带的。如果仅需要补全用它就够了。
  • 坏处是功能实现的比较少,而且它没办法找到在./build目录下的compile_commands.json,你必须软链接到项目根目录才行。

cquery就几乎是个全功能的Language Server了。它支持:

  1. 代码格式化; [clangd也可以]
  2. 跨文件重命名symbol;
  3. 定义跳转;
  4. 引用跳转;
  5. 枚举引用列表;
  6. 文档内Symbol搜索;
  7. 工程内Symbol搜索(包括各种头文件);
  8. 快速定位Diagnostic位置;

我刚刚配置完进去实际工程里面溜一圈,确实爽的多。越来越像IDE了。只有一个功能貌似用不了:implementation是没法从头文件跳去cpp文件的。但是呢,却可以从reference列表跳转(列表第一项),所以也不是什么问题了。

配置

其实Deoplete + LanguageClient + cquery,不知道是不是心里作用,虽然配置起来行数多了。但是比YCM好懂得多。

首先,安装好neovim python clientcquery。如果是Arch,cquery就在AUR上,全自动编译。实在懒得编译也可以上国内的archlinuxcn源,里面之前是有cquery二进制的。

然后下载那两个插件,再加一个fzf。因为languageClient的列表什么的都是用fzf做交互的。再者说,现在用linux谁还不用fzf?下面是vim-plug部分:

Plug 'autozimu/LanguageClient-neovim', {
    \ 'branch': 'next',
    \ 'do': 'bash install.sh',
    \ }
Plug 'Shougo/deoplete.nvim', { 'do': ':UpdateRemotePlugins' }

下面配置Deoplete:

" 自启动
let g:deoplete#enable_at_startup = 1
" smart case不解释
let g:deoplete#enable_smart_case = 1

" 用户输入至少两个字符时再开始提示补全
call deoplete#custom#source('LanguageClient',
            \ 'min_pattern_length',
            \ 2)

" 字符串中不补全
call deoplete#custom#source('_',
            \ 'disabled_syntaxes', ['String']
            \ )

" 补全结束或离开插入模式时,关闭预览窗口
autocmd InsertLeave,CompleteDone * if pumvisible() == 0 | pclose | endif

" 为每个语言定义completion source
" 是的vim script和zsh script都有,这就是deoplete
call deoplete#custom#option('sources', {
            \ 'cpp': ['LanguageClient'],
            \ 'c': ['LanguageClient'],
            \ 'vim': ['vim'],
            \ 'zsh': ['zsh']
            \})

" 忽略一些没意思的completion source。
let g:deoplete#ignore_sources = {}
let g:deoplete#ignore_sources._ = ['buffer', 'around']

再来配置LanguageClient

" abandoned的Buffer隐藏起来,这是vim的设置。
" 如果没有这个设置,修改过的文件需要保存了才能换buffer
" 这会影响全局重命名,因为Vim提示保存因此打断下一个文件的重命名。
set hidden
" 告诉LS那个文件夹才是project root,同时也告诉它compile_commands在哪里
let g:LanguageClient_rootMarkers = {
            \ 'cpp': ['compile_commands.json', 'build'],
            \ 'c': ['compile_commands.json', 'build']
            \ }
" 为语言指定Language server和server的参数
let g:LanguageClient_serverCommands = {
            \ 'cpp': ['cquery', '--log-file=/tmp/cq.log'],
            \ 'c': ['cquery', '--log-file=/tmp/cq.log'],
            \ }

" Server加一个参数就放在下列文件中
let g:LanguageClient_loadSettings = 1
let g:LanguageClient_settingsPath = '爱放哪里放哪里'
" 把Server的补全API提交给Vim
" 一般有deoplete就可以用了,加上一条以防万一。
set completefunc=LanguageClient#complete
" 把Server的格式化API提交给Vim
set formatexpr=LanguageClient_textDocument_rangeFormatting()

因为默认Deoplete的补全是ctrl-n下翻和ctrl-p上翻,如果喜欢tab还可以加上两行:

inoremap  pumvisible() ? "\" : "\"
inoremap  pumvisible() ? "\" : "\"

最后在settings.json 里面写下你的server的别的参数:

{
    "initializationOptions": {
        "cacheDirectory": "/tmp/cquery"
    }
}

记得把路径写到上面的配置里面去。
记得装fzf

使用

写的太多了,困了。自己看文档吧。

Happy Vimming!

你可能感兴趣的:(Life With Vim[2] 用Deoplete和cquery搭建代码补全)