一步一步带你安装史上最难安装的 vim 插件 —— YouCompleteMe

Myth丶恋晨 2022-05-18 00:24 333阅读 0赞

转自：[https://www.jianshu.com/p/d908ce81017a][https_www.jianshu.com_p_d908ce81017a]

> YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim.  
> **参考： [https://github.com/Valloric/YouCompleteMe\#full-installation-guide][https_github.com_Valloric_YouCompleteMe_full-installation-guide]**  
> 本篇文章默认读者知道什么是 unix/linux，vim/vi， YouCompleteMe，如果有不清楚的，`Search engine is your friend` 或者留言讨论。YouCompleteMe 简称 YCM 以下都称为 YCM。

[YouCompleteMe][] 的强大想必大家都听说过，简单的用一句话来概括的话，`媲美 VS 的自动补全` 当然可能有一点点过，但可见其强大。但是作为一个十分强大的 vim 插件，他可是十分的难以安装，几乎所有的人，都会在安装阶段苦苦挣扎（别问老夫怎么知道的），然后要么成功安装享受工具带来的便利，要么放弃继续使用传统的自动补全工具（当然也没有那么差，但可能没有 YCM 那么强大）。

经过老夫的辛苦探索，终于在听到 YCM 大名的一年之后成功安装，所以分享出来，希望能够帮助到更多的人。另外如果在安装过程中遇到任何问题都欢迎在评论与我讨论。

> 有了你我才是我，你的存在令我完整  
> —— 老夫

系统环境：Kali-Rolling on Oracle VirtualBox，可以当作是最新版（或者说实验版）的 Debian

目标：成功安装使用 YCM， 尽量少的编译软件（即尽量使用预编译 deb 包），尽量可以实现更多种语言的自动补全

# 安装步骤： #

0. 确保 vim 版本是 7.4.143 或以上，并且支持 python 2/3 脚本

![700][]

vim version

从上图可以看出老夫的 vim 版本是 8.0.49 且支持 python3 脚本但不支持 python2 脚本（截图的倒数第 7，8 行）  
如果你的打印结果中没有相关 python 脚本信息，还可以在 vim 中键入命令 `:echo has('python') || has('python3')`，若结果是 1 则证明是支持的。

若不论是 vim 版本不满足条件或者是不支持 python 脚本，那么就需要[从源码编译安装 vim][vim] 了，

1. 通过 Vundle 来安装 YCM（官方推荐）

[快速安装 vim 的插件管理插件 vundle][vim _ vundle]

在 vim 的配置文件 `~/.vimrc` 中添加一行（在`call vundle#begin()` 和 `call vundle#end()` 之间）

call vundle#begin()
    . . . 
    Plugin 'Valloric/YouCompleteMe’
    . . .
    call vundle#end()

然后保存运行 vim 命令 `:PluginInstall` 安装 **需要特别注意的是这个时候可能等的时间会相当的长**

这个时候打开 vim 可能则会有警告如下图

![700 1][]

vim warning

1.5 通过 Git 安装 YCM

如果你跟老夫一样，等待 Vundle 安装 YCM 等了好久终于貌似好像成功了，打开 vim 却发现 `YouCompleteme unavailable : no module named future` （当然没有遇到算你运气好），那么你应该考虑一下换用 Git 来安装 YCM：

# 下载 （在 `～/.vim/bundle` 目录下）
    $ git clone --recursive [https://github.com/Valloric/YouCompleteMe.git](https://github.com/Valloric/YouCompleteMe.git)
    # 检查完整性（在 `～/.vim/bundle/YouCompleteMe` 目录下）
    $ git submodule update --init --recursive

2. 下载安装最新版的 libclang

如果不需要 C 家族的语义化补全，则可跳过这一步

# apt-get install llvm-3.9 clang-3.9 libclang-3.9-dev libboost-all-dev

PS: \*\* YCM 官方墙烈推荐使用上游编译的二进制文件代替系统自带的 libclang\*\*

> You can use the system libclang **only if you are sure it is version 3.9 or higher**, otherwise don't. Even if it is, we recommend using the [official binaries from llvm.org][] if at all possible. Make sure you download the correct archive file for your OS.

> We **STRONGLY recommend AGAINST use** of the system libclang instead of the upstream compiled binaries. Random things may break. Save yourself the hassle and use the upstream pre-built libclang.

3. 编译构建 `ycm_core` 库

> \*\* 需要：cmake python3-dev\*\*

YCM 的顶层目录或者说根目录应该是 `～/.vim/bundle/YouCompleteMe`

*  **创建一个目录放编译过程中产生的文件**

$ mkdir ~/.ycm_build
    $ cd ~/.ycm_build

*  **生成 makefile**

如果跳过第三步的话，则可以直接运行

$ cmake -G "Unix Makefiles" . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp

如果没有跳过第三步，说明需要 c 家族的语义化补全则需运行

$ cmake -G "Unix Makefiles" -DUSE_SYSTEM_BOOST=ON DUSE_SYSTEM_LIBCLANG=ON . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp

![700 2][]

有问题的编译

编译通过的，没有报错，但是这个编译结果是有问题的，看第 3 行，反复强调的 c 家族的语义补全没有了。经过老夫反复的检查，原来是上面的编译命令少了一个 `-` 符号

$ cmake -G "Unix Makefiles" -DUSE_SYSTEM_BOOST=ON -DUSE_SYSTEM_LIBCLANG=ON . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp

这个时候编译的过程如下图：

![700 3][]

编译正常

其实这个还是有问题的，看倒数第 3、4 行，使用的是外部的 libclang-3.6 ，第 2 步中说的系统安装的 libclang 最低要是是 3.9。  
这个时候就需要删除 `~/.ycm_build` 目录下的所有文件，使用下面的命令指定 libclang 的版本重新编译。

$ cmake -G "Unix Makefiles" -DUSE_SYSTEM_BOOST=ON -DEXTERNAL_LIBCLANG_PATH=/usr/lib/x86_64-linux-gnu/libclang-3.9.so . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp

编译的结果是之前新建的目录（也就是当前目录下生成了一些 Makefile 文件）

![655][]

Makefile

*  构建 ycm\_core

#  --config Release 这个构建选项进针对 Windows
    $ cmake --build . --target ycm_core --config Release

![700 4][]

build ycm\_core

3.5 配置

*  复制 .ycm\_extra\_conf.py 文件

$ cp ~/.vim/bundle/YouCompleteMe/third_party/ycmd/examples/.ycm_extra_conf.py ~/.vim/

*  添加 vim 配置  
    注意下面的 python 解释器的路径要和编译 ycm\_core 的时候使用的 python 解释器是相同的版本（2 或 3）

“ ～/.vimrc
    let g:ycm_server_python_interpreter='/usr/bin/python'
    let g:ycm_global_ycm_extra_conf='~/.vim/.ycm_extra_conf.py'

4. 其他语言的支持

C\#、Go、TypeScript、 JavaScript、 Rust support  
由于老夫对这些语言没有太多的涉猎就不做介绍了。

5. 测试安装

首先新建一个 hello.c 文件，

![700 5][]

hello.c

可以看到自动补全了头文件，厉害了老夫的 YCM

然后在 vim 中运行 `:YcmToggleLogs stderr` 命令查看错误日志，

![700 6][]

stderr

没有看到报错信息，则证明 YCM 已成功安装。

[https_www.jianshu.com_p_d908ce81017a]: https://www.jianshu.com/p/d908ce81017a
[https_github.com_Valloric_YouCompleteMe_full-installation-guide]: https://link.jianshu.com/?t=https://github.com/Valloric/YouCompleteMe#full-installation-guide
[YouCompleteMe]: https://link.jianshu.com/?t=https://github.com/Valloric/YouCompleteMe
[700]: /images/20220518/2b5b1827d1394a43b773e733d7891f8b.png
[vim]: https://link.jianshu.com/?t=https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source
[vim _ vundle]: https://link.jianshu.com/?t=https://github.com/VundleVim/Vundle.vim#quick-start
[700 1]: /images/20220518/20b54ee6e34241f6a91bcdb48b7696b5.png
[official binaries from llvm.org]: https://link.jianshu.com/?t=http://llvm.org/releases/download.html
[700 2]: /images/20220518/d212b3d6579a4ecdbeff0cb75947beb5.png
[700 3]: /images/20220518/fc0d9a69739e4754b0e89ad84a8f2c69.png
[655]: /images/20220518/55c478833be049a6a58dc2852a2e2f03.png
[700 4]: /images/20220518/b80194bbe8714311ad83cda5eb038897.png
[700 5]: /images/20220518/705939bb4aa644df84f0b255e33ddcbe.png
[700 6]: /images/20220518/f8d95de542c84c97b04853124c7c9d90.png