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

2017-02-20 14:16:54 +08:00
 jpush

YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim. 参考: 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 脚本

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

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

1. 通过 Vundle 来安装 YCM (官方推荐)

快速安装 vim 的插件管理插件 vundle

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

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

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

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

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

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

$ 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

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

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

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

其实这个还是有问题的,看倒数第 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 文件)

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

3.5 配置

$ cp ~/.vim/bundle/YouCompleteMe/third_party/ycmd/examples/.ycm_extra_conf.py ~/.vim/
“ ~/.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 文件,

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

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

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

作者:老東 D 不知火-极光

原文: http://www.jianshu.com/p/d908ce81017a

20200 次点击
所在节点    Vim
58 条回复
jpush
2017-02-20 17:09:44 +08:00
@Immortal 确实有这方面原因,但是,从听说 YCM 大名到安装成功花了老夫半年时间徘徊
jpush
2017-02-20 17:12:11 +08:00
@Muninn 不知道你说的是什么意思,

> These instructions (using install.py) are the quickest way to install YouCompleteMe, however they may not work for everyone

这是 README 原文,作者只是分享了自己的安装经历
jsfaint
2017-02-20 17:12:13 +08:00
也就是 windows 麻烦啊, Linux 和 mac 一个脚本就搞定了
https://gist.github.com/jsfaint/efeeae54c2400b42c12a
jpush
2017-02-20 17:13:51 +08:00
@daben1990 这个嘛, YCM 也是有脾气的吧 lol
jpush
2017-02-20 17:14:31 +08:00
@SourceMan 已经让刚刚那个同志吃过药了
jpush
2017-02-20 17:18:55 +08:00
@whatot 你这个是 VIM 的配置语法吗? 是不是有错别字 Plugin,另外的话 Arch 很棒啊, Arch 平台是有第三方的 AUR 包直接安装,你可以看一下他的 WIKI : https://wiki.archlinux.org/index.php/YouCompleteMe#Installation
ps : 现在的大环境还是用 python3 吧
jpush
2017-02-20 17:20:39 +08:00
@diffworld neocomplete 也很棒,选择适合自己的插件才是正确的选择
lingoerer
2017-02-20 17:20:41 +08:00
我换用 neovim 的原因之一就是可以不用 YCM ,改用 Deoplete ……
jpush
2017-02-20 17:23:00 +08:00
@linuap
@lypdarling

会的人自然觉得不难,你们就当作者翻译了一下 full-installation 的 README 吧
jpush
2017-02-20 17:23:42 +08:00
@chez 你以为作者会告诉你他的真实意图吗,
jpush
2017-02-20 17:25:56 +08:00
@lingoerer 其实作者用的最多的还是 sublime text 3, 所以用什么工具并不重要,重要的是能否解决问题。 neovim 或者之前国内某个人的 spacevim 都算是完成度比较高的 vim 配置了,不喜欢折腾的大可以尝试一下
ivenvd
2017-02-20 17:27:30 +08:00
@jpush neovim 不是 vim 配置哦……是 vim 的 fork ……
CodeingBoy
2017-02-20 18:34:03 +08:00
@jpush 哦 那样应该是没问题的 经常看到有全文转载过来就被举报的 因此提醒一下~见谅

ycm 装过一次,确实难装,我要用 C/C++的自动补全,配置过也不成功
Mush
2017-02-20 18:56:23 +08:00
自从我把开发环境挪到了 Docker 里面, 就再也没有操心过这些事情了.....
neosfung
2017-02-20 19:30:17 +08:00
n 久之前写下来的记录,不知道还能不能够用

```
sudo apt-get install -y build-essential cmake \
python-dev libclang-dev \
vim-addon-manager vim-youcompleteme

vam install youcompleteme
```
whatot
2017-02-20 19:54:36 +08:00
@jpush Plug 是 vim-plug 的命令,能够在安装与更新插件的时候自动执行注册的命令,完成自动编译
xiaohanqing
2017-02-20 20:29:28 +08:00
我觉得原生的 omni 就很好用啊
fzleee
2017-02-20 21:08:17 +08:00
同意 @Immortal 的看法,这东西所谓的难安装完全是因为国内网络环境的问题。 YCM 的安装包实在是太大,下载耗时且经常会失败。

总结一下安装流程,无非就是:
1. 通过 Vundle 下载软件。
2. 安装编译 YCM 需要的库,比如 CMake 之类的。
3. python install.py

现在的主流的操作系统,通过软件源安装 VIM 一般都是大于 7.4 的吧,一般都默认有 Python 支持的吧。所以这些地方出问题实在是小概率事件。

看完这个教程,感觉有点将这个事情复杂化了,会让初次安装 YCM 的人感觉一头雾水。
Technetiumer
2017-02-20 22:05:03 +08:00
@msg7086 所以说你至于举报么
@SourceMan 我不认为他火气大了

禁止全文转载属于必须严格遵守的硬性规定?怪不得这里是个人网站而不是社区网站。
fy
2017-02-20 22:10:45 +08:00
停一下朋友,讲道理 YCM 这玩意还装个卵子,又难配又卡……

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/341751

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX