vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add Gitter badge

Browse Source
This commit is contained in:
micbou 2016-10-31 17:48:35 +01:00
parent c895f09375
commit 9605c1d50a
No known key found for this signature in database
GPG Key ID: C7E8FD1F3BDA1E05
3 changed files with 210 additions and 203 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -7,8 +7,9 @@ YCM to work on my machine" and the reason why is obviously related to your
machine configuration and the problem would not be resolved with _reasonable_ machine configuration and the problem would not be resolved with _reasonable_
changes to the YCM codebase, then the issue is likely to be closed. changes to the YCM codebase, then the issue is likely to be closed.
**A good place to ask questions is the [ycm-users][] Google group**. Rule of **A good place to ask questions is the [Gitter room][gitter] or the
thumb: if you're not sure whether your problem is a real bug, ask on the group. [ycm-users][] Google group**. Rule of thumb: if you're not sure whether your
problem is a real bug, ask on the room or the group.
**YCM compiles just fine**; [the build bots say so][build-bots]. If the bots are **YCM compiles just fine**; [the build bots say so][build-bots]. If the bots are
green and YCM doesn't compile on your machine, then _your machine is the root green and YCM doesn't compile on your machine, then _your machine is the root
@ -110,3 +111,4 @@ Creating good pull requests
[build-bots]: https://travis-ci.org/Valloric/YouCompleteMe [build-bots]: https://travis-ci.org/Valloric/YouCompleteMe
[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users [ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users
[gitter]: https://gitter.im/Valloric/YouCompleteMe

6
README.md
View File

@ -1,6 +1,7 @@
YouCompleteMe: a code-completion engine for Vim YouCompleteMe: a code-completion engine for Vim
=============================================== ===============================================
[![Gitter Room](https://img.shields.io/gitter/room/Valloric/YouCompleteMe.svg)](https://gitter.im/Valloric/YouCompleteMe)
[![Build Status](https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master)](https://travis-ci.org/Valloric/YouCompleteMe) [![Build Status](https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master)](https://travis-ci.org/Valloric/YouCompleteMe)
[![Build status](https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true)](https://ci.appveyor.com/project/Valloric/YouCompleteMe) [![Build status](https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true)](https://ci.appveyor.com/project/Valloric/YouCompleteMe)
[![Coverage Status](https://codecov.io/gh/Valloric/YouCompleteMe/branch/master/graph/badge.svg)](https://codecov.io/gh/Valloric/YouCompleteMe) [![Coverage Status](https://codecov.io/gh/Valloric/YouCompleteMe/branch/master/graph/badge.svg)](https://codecov.io/gh/Valloric/YouCompleteMe)
@ -2894,8 +2895,8 @@ terms.
Contact Contact
------- -------
If you have questions about the plugin or need help, please use the If you have questions about the plugin or need help, please join the [Gitter
[ycm-users][] mailing list. room][gitter] or use the [ycm-users][] mailing list.
If you have bug reports or feature suggestions, please use the [issue If you have bug reports or feature suggestions, please use the [issue
tracker][tracker]. tracker][tracker].
@ -2975,3 +2976,4 @@ This software is licensed under the [GPL v3 license][gpl].
[JediHTTP]: https://github.com/vheon/JediHTTP [JediHTTP]: https://github.com/vheon/JediHTTP
[vim_win-python2.7.11-bug]: https://github.com/vim/vim/issues/717 [vim_win-python2.7.11-bug]: https://github.com/vim/vim/issues/717
[vim_win-python2.7.11-bug_workaround]: https://github.com/vim/vim-win32-installer/blob/master/appveyor.bat#L90 [vim_win-python2.7.11-bug_workaround]: https://github.com/vim/vim-win32-installer/blob/master/appveyor.bat#L90
[gitter]: https://gitter.im/Valloric/YouCompleteMe

401
doc/youcompleteme.txt
View File

@ -172,7 +172,8 @@ module could not be loaded" |E887:-Sorry-this-command-is-disabled-the-Python-s-s
*youcompleteme-introduction* *youcompleteme-introduction*
Introduction ~ Introduction ~
Image: Build Status [1] Image: Build status [3] Image: Coverage Status [5] Image: Gitter Room [1] Image: Build Status [3] Image: Build status [5] Image:
Coverage Status [7]
- Intro - Intro
- Installation - Installation
@ -227,28 +228,28 @@ Vim. It has several completion engines:
- an identifier-based engine that works with every programming language, - an identifier-based engine that works with every programming language,
- a Clang [7]-based engine that provides native semantic code completion for - a Clang [9]-based engine that provides native semantic code completion for
C/C++/Objective-C/Objective-C++ (from now on referred to as "the C-family C/C++/Objective-C/Objective-C++ (from now on referred to as "the C-family
languages"), languages"),
- a Jedi [8]-based completion engine for Python 2 and 3 (using the JediHTTP - a Jedi [10]-based completion engine for Python 2 and 3 (using the JediHTTP
[9] wrapper), [11] wrapper),
- an OmniSharp [10]-based completion engine for C#, - an OmniSharp [12]-based completion engine for C#,
- a combination of Gocode [11] and Godef [12] semantic engines for Go, - a combination of Gocode [13] and Godef [14] semantic engines for Go,
- a TSServer [13]-based completion engine for TypeScript, - a TSServer [15]-based completion engine for TypeScript,
- a Tern [14]-based completion engine for JavaScript, - a Tern [16]-based completion engine for JavaScript,
- a racer [15]-based completion engine for Rust, - a racer [17]-based completion engine for Rust,
- and an omnifunc-based completer that uses data from Vim's omnicomplete - and an omnifunc-based completer that uses data from Vim's omnicomplete
system to provide semantic completions for many other languages (Ruby, PHP system to provide semantic completions for many other languages (Ruby, PHP
etc.). etc.).
Image: YouCompleteMe GIF demo (see reference [16]) Image: YouCompleteMe GIF demo (see reference [18])
Here's an explanation of what happens in the short GIF demo above. Here's an explanation of what happens in the short GIF demo above.
@ -267,7 +268,7 @@ typing to further filter out unwanted completions.
A critical thing to notice is that the completion **filtering is NOT based on A critical thing to notice is that the completion **filtering is NOT based on
the input being a string prefix of the completion** (but that works too). The the input being a string prefix of the completion** (but that works too). The
input needs to be a _subsequence [17] match_ of a completion. This is a fancy input needs to be a _subsequence [19] match_ of a completion. This is a fancy
way of saying that any input characters need to be present in a completion way of saying that any input characters need to be present in a completion
string in the order in which they appear in the input. So 'abc' is a string in the order in which they appear in the input. So 'abc' is a
subsequence of 'xaybgc', but not of 'xbyxaxxc'. After the filter, a complicated subsequence of 'xaybgc', but not of 'xbyxaxxc'. After the filter, a complicated
@ -286,7 +287,7 @@ with a keyboard shortcut; see the rest of the docs).
The last thing that you can see in the demo is YCM's diagnostic display The last thing that you can see in the demo is YCM's diagnostic display
features (the little red X that shows up in the left gutter; inspired by features (the little red X that shows up in the left gutter; inspired by
Syntastic [18]) if you are editing a C-family file. As Clang compiles your file Syntastic [20]) if you are editing a C-family file. As Clang compiles your file
and detects warnings or errors, they will be presented in various ways. You and detects warnings or errors, they will be presented in various ways. You
don't need to save your file or press any keyboard shortcut to trigger this, it don't need to save your file or press any keyboard shortcut to trigger this, it
"just happens" in the background. "just happens" in the background.
@ -315,7 +316,7 @@ summary and the full list of completer subcommands to find out what's available
for your favourite languages. for your favourite languages.
You'll also find that YCM has filepath completers (try typing './' in a file) You'll also find that YCM has filepath completers (try typing './' in a file)
and a completer that integrates with UltiSnips [19]. and a completer that integrates with UltiSnips [21].
=============================================================================== ===============================================================================
*youcompleteme-installation* *youcompleteme-installation*
@ -328,16 +329,16 @@ Mac OS X ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
Install the latest version of MacVim [20]. Yes, MacVim. And yes, the _latest_. Install the latest version of MacVim [22]. Yes, MacVim. And yes, the _latest_.
If you don't use the MacVim GUI, it is recommended to use the Vim binary that If you don't use the MacVim GUI, it is recommended to use the Vim binary that
is inside the MacVim.app package ('MacVim.app/Contents/MacOS/Vim'). To ensure is inside the MacVim.app package ('MacVim.app/Contents/MacOS/Vim'). To ensure
it works correctly copy the 'mvim' script from the MacVim [20] download to your it works correctly copy the 'mvim' script from the MacVim [22] download to your
local binary folder (for example '/usr/local/bin/mvim') and then symlink it: local binary folder (for example '/usr/local/bin/mvim') and then symlink it:
> >
ln -s /usr/local/bin/mvim vim ln -s /usr/local/bin/mvim vim
< <
Install YouCompleteMe with Vundle [21]. Install YouCompleteMe with Vundle [23].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM **Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens rarely), YCM using Vundle and the ycm_core library APIs have changed (happens rarely), YCM
@ -348,8 +349,8 @@ installed along with the latest Command Line Tools (they are installed
automatically when you run 'clang' for the first time, or manually by running automatically when you run 'clang' for the first time, or manually by running
'xcode-select --install') 'xcode-select --install')
Install CMake. Preferably with Homebrew [22], but here's the stand-alone CMake Install CMake. Preferably with Homebrew [24], but here's the stand-alone CMake
installer [23]. installer [25].
_If_ you have installed a Homebrew Python and/or Homebrew MacVim, see the _FAQ_ _If_ you have installed a Homebrew Python and/or Homebrew MacVim, see the _FAQ_
for details. for details.
@ -366,19 +367,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: install Mono with Homebrew [22] or by downloading the Mono Mac - C# support: install Mono with Homebrew [24] or by downloading the Mono Mac
package [24] and add '--omnisharp-completer' when calling './install.py'. package [26] and add '--omnisharp-completer' when calling './install.py'.
- Go support: install Go [25] and add '--gocode-completer' when calling - Go support: install Go [27] and add '--gocode-completer' when calling
'./install.py'. './install.py'.
- TypeScript support: install Node.js and npm [26] then install the - TypeScript support: install Node.js and npm [28] then install the
TypeScript SDK with 'npm install -g typescript'. TypeScript SDK with 'npm install -g typescript'.
- JavaScript support: install Node.js and npm [26] and add '--tern-completer' - JavaScript support: install Node.js and npm [28] and add '--tern-completer'
when calling './install.py'. when calling './install.py'.
- Rust support: install Rust [27] and add '--racer-completer' when calling - Rust support: install Rust [29] and add '--racer-completer' when calling
'./install.py'. './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
@ -408,9 +409,9 @@ provided on a best-effort basis and may not work for you.
Make sure you have Vim 7.4.143 with Python 2 or Python 3 support. Ubuntu 14.10 Make sure you have Vim 7.4.143 with Python 2 or Python 3 support. Ubuntu 14.10
and later have a Vim that's recent enough. You can see the version of Vim and later have a Vim that's recent enough. You can see the version of Vim
installed by running 'vim --version'. If the version is too old, you may need installed by running 'vim --version'. If the version is too old, you may need
to compile Vim from source [28] (don't worry, it's easy). to compile Vim from source [30] (don't worry, it's easy).
Install YouCompleteMe with Vundle [21]. Install YouCompleteMe with Vundle [23].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM **Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens rarely), YCM using Vundle and the ycm_core library APIs have changed (happens rarely), YCM
@ -434,19 +435,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: install Mono [29] and add '--omnisharp-completer' when calling - C# support: install Mono [31] and add '--omnisharp-completer' when calling
'./install.py'. './install.py'.
- Go support: install Go [25] and add '--gocode-completer' when calling - Go support: install Go [27] and add '--gocode-completer' when calling
'./install.py'. './install.py'.
- TypeScript support: install Node.js and npm [26] then install the - TypeScript support: install Node.js and npm [28] then install the
TypeScript SDK with 'npm install -g typescript'. TypeScript SDK with 'npm install -g typescript'.
- JavaScript support: install Node.js and npm [26] and add '--tern-completer' - JavaScript support: install Node.js and npm [28] and add '--tern-completer'
when calling './install.py'. when calling './install.py'.
- Rust support: install Rust [27] and add '--racer-completer' when calling - Rust support: install Rust [29] and add '--racer-completer' when calling
'./install.py'. './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
@ -476,9 +477,9 @@ provided on a best-effort basis and may not work for you.
Make sure you have Vim 7.4.143 with Python 2 or Python 3 support. Fedora 21 and Make sure you have Vim 7.4.143 with Python 2 or Python 3 support. Fedora 21 and
later have a Vim that's recent enough. You can see the version of Vim installed later have a Vim that's recent enough. You can see the version of Vim installed
by running 'vim --version'. If the version is too old, you may need to compile by running 'vim --version'. If the version is too old, you may need to compile
Vim from source [28] (don't worry, it's easy). Vim from source [30] (don't worry, it's easy).
Install YouCompleteMe with Vundle [21]. Install YouCompleteMe with Vundle [23].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM **Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens rarely), YCM using Vundle and the ycm_core library APIs have changed (happens rarely), YCM
@ -502,19 +503,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: install Mono [30] and add '--omnisharp-completer' when calling - C# support: install Mono [32] and add '--omnisharp-completer' when calling
'./install.py'. './install.py'.
- Go support: install Go [25] and add '--gocode-completer' when calling - Go support: install Go [27] and add '--gocode-completer' when calling
'./install.py'. './install.py'.
- TypeScript support: install Node.js and npm [26] then install the - TypeScript support: install Node.js and npm [28] then install the
TypeScript SDK with 'npm install -g typescript'. TypeScript SDK with 'npm install -g typescript'.
- JavaScript support: install Node.js and npm [26] and add '--tern-completer' - JavaScript support: install Node.js and npm [28] and add '--tern-completer'
when calling './install.py'. when calling './install.py'.
- Rust support: install Rust [27] and add '--racer-completer' when calling - Rust support: install Rust [29] and add '--racer-completer' when calling
'./install.py'. './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
@ -550,9 +551,9 @@ Vim. Look at the features included: '+python/dyn' for Python 2 and
'+python3/dyn' for Python 3. Take note of the Vim architecture, i.e. 32 or '+python3/dyn' for Python 3. Take note of the Vim architecture, i.e. 32 or
64-bit. It will be important when choosing the Python installer. We recommend 64-bit. It will be important when choosing the Python installer. We recommend
using a 64-bit client. Daily updated copies of 32-bit and 64-bit Vim with using a 64-bit client. Daily updated copies of 32-bit and 64-bit Vim with
Python 2 and Python 3 support [31] are available. Python 2 and Python 3 support [33] are available.
Install YouCompleteMe with Vundle [21]. Install YouCompleteMe with Vundle [23].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM **Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens rarely), YCM using Vundle and the ycm_core library APIs have changed (happens rarely), YCM
@ -560,16 +561,16 @@ will notify you to recompile it. You should then rerun the install process.
Download and install the following software: Download and install the following software:
- Python 2 or Python 3 [32]. Be sure to pick the version corresponding to - Python 2 or Python 3 [34]. Be sure to pick the version corresponding to
your Vim architecture. It is _Windows x86_ for a 32-bit Vim and _Windows your Vim architecture. It is _Windows x86_ for a 32-bit Vim and _Windows
x86-64_ for a 64-bit Vim. We recommend installing Python 3. x86-64_ for a 64-bit Vim. We recommend installing Python 3.
- CMake [23]. Add CMake executable to the PATH environment variable. - CMake [25]. Add CMake executable to the PATH environment variable.
- Visual Studio [33]. Download the community edition. During setup, choose - Visual Studio [35]. Download the community edition. During setup, choose
_Custom_ as the installation type and select the _Visual C++_ component. _Custom_ as the installation type and select the _Visual C++_ component.
- 7-zip [34]. Required to build YCM with semantic support for C-family - 7-zip [36]. Required to build YCM with semantic support for C-family
languages. languages.
Compiling YCM **with** semantic support for C-family languages: Compiling YCM **with** semantic support for C-family languages:
@ -585,18 +586,18 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' when calling |install.py|. Be sure - C# support: add '--omnisharp-completer' when calling |install.py|. Be sure
that the build utility 'msbuild' is in your PATH [35]. that the build utility 'msbuild' is in your PATH [37].
- Go support: install Go [25] and add '--gocode-completer' when calling - Go support: install Go [27] and add '--gocode-completer' when calling
|install.py|. |install.py|.
- TypeScript support: install Node.js and npm [26] then install the - TypeScript support: install Node.js and npm [28] then install the
TypeScript SDK with 'npm install -g typescript'. TypeScript SDK with 'npm install -g typescript'.
- JavaScript support: install Node.js and npm [26] and add '--tern-completer' - JavaScript support: install Node.js and npm [28] and add '--tern-completer'
when calling |install.py|. when calling |install.py|.
- Rust support: install Rust [27] and add '--racer-completer' when calling - Rust support: install Rust [29] and add '--racer-completer' when calling
|install.py|. |install.py|.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
@ -637,7 +638,7 @@ FreeBSD 10.x comes with clang compiler but not the libraries needed to install.
pkg install llvm38 boost-all boost-python-libs clang38 pkg install llvm38 boost-all boost-python-libs clang38
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/llvm38/lib/ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/llvm38/lib/
< <
Install YouCompleteMe with Vundle [21]. Install YouCompleteMe with Vundle [23].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM **Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens rarely), YCM using Vundle and the ycm_core library APIs have changed (happens rarely), YCM
@ -660,16 +661,16 @@ The following additional language support options are available:
- C# support: install Mono and add '--omnisharp-completer' when calling - C# support: install Mono and add '--omnisharp-completer' when calling
'./install.py'. './install.py'.
- Go support: install Go [25] and add '--gocode-completer' when calling - Go support: install Go [27] and add '--gocode-completer' when calling
'./install.py'. './install.py'.
- TypeScript support: install Node.js and npm [26] then install the - TypeScript support: install Node.js and npm [28] then install the
TypeScript SDK with 'npm install -g typescript'. TypeScript SDK with 'npm install -g typescript'.
- JavaScript support: install Node.js and npm [26] and add '--tern-completer' - JavaScript support: install Node.js and npm [28] and add '--tern-completer'
when calling './install.py'. when calling './install.py'.
- Rust support: install Rust [27] and add '--racer-completer' when calling - Rust support: install Rust [29] and add '--racer-completer' when calling
'./install.py'. './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
@ -718,7 +719,7 @@ will notify you to recompile it. You should then rerun the install process.
1-Z', where Z will be some number. That number needs to be 143 or higher. 1-Z', where Z will be some number. That number needs to be 143 or higher.
If your version of Vim is not recent enough, you may need to compile Vim If your version of Vim is not recent enough, you may need to compile Vim
from source [28] (don't worry, it's easy). from source [30] (don't worry, it's easy).
After you have made sure that you have Vim 7.4.143+, type the following After you have made sure that you have Vim 7.4.143+, type the following
in Vim: ":echo has('python') || has('python3')". The output should be 1. in Vim: ":echo has('python') || has('python3')". The output should be 1.
@ -728,9 +729,9 @@ will notify you to recompile it. You should then rerun the install process.
critical because it must match the Python and the YCM libraries critical because it must match the Python and the YCM libraries
architectures. We recommend using a 64-bit Vim. architectures. We recommend using a 64-bit Vim.
2. **Install YCM** with Vundle [21] (or Pathogen [36], but Vundle is a 2. **Install YCM** with Vundle [23] (or Pathogen [38], but Vundle is a
better idea). With Vundle, this would mean adding a "Plugin better idea). With Vundle, this would mean adding a "Plugin
'Valloric/YouCompleteMe'" line to your vimrc [37]. 'Valloric/YouCompleteMe'" line to your vimrc [39].
If you don't install YCM with Vundle, make sure you have run 'git If you don't install YCM with Vundle, make sure you have run 'git
submodule update --init --recursive' after checking out the YCM submodule update --init --recursive' after checking out the YCM
@ -747,7 +748,7 @@ will notify you to recompile it. You should then rerun the install process.
You can use the system libclang _only if you are sure it is version 3.8 You can use the system libclang _only if you are sure it is version 3.8
or higher_, otherwise don't. Even if it is, we recommend using the or higher_, otherwise don't. Even if it is, we recommend using the
official binaries from llvm.org [38] if at all possible. Make sure you official binaries from llvm.org [40] if at all possible. Make sure you
download the correct archive file for your OS. download the correct archive file for your OS.
We **STRONGLY recommend AGAINST use** of the system libclang instead of We **STRONGLY recommend AGAINST use** of the system libclang instead of
@ -760,17 +761,17 @@ will notify you to recompile it. You should then rerun the install process.
You will need to have 'cmake' installed in order to generate the required You will need to have 'cmake' installed in order to generate the required
makefiles. Linux users can install cmake with their package manager makefiles. Linux users can install cmake with their package manager
('sudo apt-get install cmake' for Ubuntu) whereas other users can ('sudo apt-get install cmake' for Ubuntu) whereas other users can
download and install [23] cmake from its project site. Mac users can also download and install [25] cmake from its project site. Mac users can also
get it through Homebrew [22] with 'brew install cmake'. get it through Homebrew [24] with 'brew install cmake'.
On a Unix OS, you need to make sure you have Python headers installed. On On a Unix OS, you need to make sure you have Python headers installed. On
a Debian-like Linux distro, this would be 'sudo apt-get install python- a Debian-like Linux distro, this would be 'sudo apt-get install python-
dev python3-dev'. On Mac they should already be present. dev python3-dev'. On Mac they should already be present.
On Windows, you need to download and install Python 2 or Python 3 [32]. On Windows, you need to download and install Python 2 or Python 3 [34].
Pick the version corresponding to your Vim architecture. You will also Pick the version corresponding to your Vim architecture. You will also
need Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by need Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by
installing Visual Studio [33]. MSVC 11 (Visual Studio 2012), 12 (2013), installing Visual Studio [35]. MSVC 11 (Visual Studio 2012), 12 (2013),
and 14 (2015) are officially supported. and 14 (2015) are officially supported.
Here we'll assume you installed YCM with Vundle. That means that the top- Here we'll assume you installed YCM with Vundle. That means that the top-
@ -813,7 +814,7 @@ will notify you to recompile it. You should then rerun the install process.
extracted the archive file to folder '~/ycm_temp/llvm_root_dir' (with extracted the archive file to folder '~/ycm_temp/llvm_root_dir' (with
'bin', 'lib', 'include' etc. folders right inside that folder). On 'bin', 'lib', 'include' etc. folders right inside that folder). On
Windows, you can extract the files from the LLVM+Clang installer using Windows, you can extract the files from the LLVM+Clang installer using
7-zip [34]. 7-zip [36].
NOTE: This _only_ works with a _downloaded_ LLVM binary package, not a NOTE: This _only_ works with a _downloaded_ LLVM binary package, not a
custom-built LLVM! See docs below for 'EXTERNAL_LIBCLANG_PATH' when using custom-built LLVM! See docs below for 'EXTERNAL_LIBCLANG_PATH' when using
@ -854,23 +855,23 @@ will notify you to recompile it. You should then rerun the install process.
5. Set up support for additional languages, as desired: 5. Set up support for additional languages, as desired:
6. C# support: install Mono on non-Windows platforms [39]. Navigate to 6. C# support: install Mono on non-Windows platforms [41]. Navigate to
'YouCompleteMe/third_party/ycmd/third_party/OmniSharpServer' and run 'YouCompleteMe/third_party/ycmd/third_party/OmniSharpServer' and run
'msbuild /property:Configuration=Release' on Windows. Replace 'msbuild' 'msbuild /property:Configuration=Release' on Windows. Replace 'msbuild'
by 'xbuild' on other platforms. On Windows, be sure that the build by 'xbuild' on other platforms. On Windows, be sure that the build
utility 'msbuild' is in your PATH [35]. utility 'msbuild' is in your PATH [37].
7. Go support: install Go [25] and add it to your path. Navigate to 7. Go support: install Go [27] and add it to your path. Navigate to
'YouCompleteMe/third_party/ycmd/third_party/gocode' and run 'go build'. 'YouCompleteMe/third_party/ycmd/third_party/gocode' and run 'go build'.
8. TypeScript support: as with the quick installation, simply 'npm install 8. TypeScript support: as with the quick installation, simply 'npm install
-g typescript' after successfully installing Node.js and npm [26]. -g typescript' after successfully installing Node.js and npm [28].
9. JavaScript support: install Node.js and npm [26]. Then navigate to 9. JavaScript support: install Node.js and npm [28]. Then navigate to
'YouCompleteMe/third_party/ycmd/third_party/tern_runtime' and run 'npm 'YouCompleteMe/third_party/ycmd/third_party/tern_runtime' and run 'npm
install --production' install --production'
10. Rust support: install Rust [27]. Navigate to 10. Rust support: install Rust [29]. Navigate to
'YouCompleteMe/third_party/ycmd/third_party/racerd' and run 'cargo 'YouCompleteMe/third_party/ycmd/third_party/racerd' and run 'cargo
build --release'. build --release'.
@ -927,7 +928,7 @@ Python ~
- Intelligent auto-completion - Intelligent auto-completion
- Go to declaration/definition, find references (|GoTo|, |GoToReferences|) - Go to declaration/definition, find references (|GoTo|, |GoToReferences|)
- View documentation comments for identifiers (|GetDoc|) - View documentation comments for identifiers (|GetDoc|)
- Restart JediHTTP [9] server using a different Python interpreter - Restart JediHTTP [11] server using a different Python interpreter
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-go* *youcompleteme-go*
@ -990,7 +991,7 @@ General Usage ~
through the completions. Use Shift-TAB to cycle backwards. Note that if through the completions. Use Shift-TAB to cycle backwards. Note that if
you're using console Vim (that is, not Gvim or MacVim) then it's likely you're using console Vim (that is, not Gvim or MacVim) then it's likely
that the Shift-TAB binding will not work because the console will not pass that the Shift-TAB binding will not work because the console will not pass
it to Vim. You can remap the keys; see the _Options [40]_ section below. it to Vim. You can remap the keys; see the _Options [42]_ section below.
Knowing a little bit about how YCM works internally will prevent confusion. YCM Knowing a little bit about how YCM works internally will prevent confusion. YCM
has several completion engines: an identifier-based completer that collects all has several completion engines: an identifier-based completer that collects all
@ -1017,7 +1018,7 @@ and presents the results to you.
Client-Server Architecture ~ Client-Server Architecture ~
YCM has a client-server architecture; the Vim part of YCM is only a thin client YCM has a client-server architecture; the Vim part of YCM is only a thin client
that talks to the ycmd HTTP+JSON server [41] that has the vast majority of YCM that talks to the ycmd HTTP+JSON server [43] that has the vast majority of YCM
logic and functionality. The server is started and stopped automatically as you logic and functionality. The server is started and stopped automatically as you
start and stop Vim. start and stop Vim.
@ -1061,20 +1062,20 @@ This system was designed this way so that the user can perform any arbitrary
sequence of operations to produce a list of compilation flags YCM should hand sequence of operations to produce a list of compilation flags YCM should hand
to Clang. to Clang.
See YCM's own '.ycm_extra_conf.py' [42] for details on how this works. You See YCM's own '.ycm_extra_conf.py' [44] for details on how this works. You
should be able to use it _as a starting point_. **Don't** just copy/paste that should be able to use it _as a starting point_. **Don't** just copy/paste that
file somewhere and expect things to magically work; **your project needs file somewhere and expect things to magically work; **your project needs
different flags**. Hint: just replace the strings in the 'flags' variable with different flags**. Hint: just replace the strings in the 'flags' variable with
compilation flags necessary for your project. That should be enough for 99% of compilation flags necessary for your project. That should be enough for 99% of
projects. projects.
Yes, Clang's 'CompilationDatabase' system [43] is also supported. Again, see Yes, Clang's 'CompilationDatabase' system [45] is also supported. Again, see
the above linked example file. You can get CMake to generate this file for you the above linked example file. You can get CMake to generate this file for you
by adding 'set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )' to your project's by adding 'set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )' to your project's
'CMakeLists.txt' file (if using CMake). If you're not using CMake, you could 'CMakeLists.txt' file (if using CMake). If you're not using CMake, you could
use something like Bear [44] to generate the 'compile_commands.json' file. use something like Bear [46] to generate the 'compile_commands.json' file.
Consider using YCM-Generator [45] to generate the 'ycm_extra_conf.py' file. Consider using YCM-Generator [47] to generate the 'ycm_extra_conf.py' file.
If Clang encounters errors when compiling the header files that your file If Clang encounters errors when compiling the header files that your file
includes, then it's probably going to take a long time to get completions. When includes, then it's probably going to take a long time to get completions. When
@ -1099,7 +1100,7 @@ Quick start ~
guide for details. guide for details.
2. Create a '.tern-project' file in the root directory of your JavaScript 2. Create a '.tern-project' file in the root directory of your JavaScript
project, by following the instructions [46] in the Tern [14] project, by following the instructions [48] in the Tern [16]
documentation. documentation.
3. Make sure that Vim's working directory is a descendent of that directory 3. Make sure that Vim's working directory is a descendent of that directory
@ -1109,14 +1110,14 @@ Quick start ~
*youcompleteme-explanation* *youcompleteme-explanation*
Explanation ~ Explanation ~
JavaScript completion is based on Tern [14]. This completion engine requires a JavaScript completion is based on Tern [16]. This completion engine requires a
file named '.tern-project' [46] to exist in the current working directory or a file named '.tern-project' [48] to exist in the current working directory or a
directory which is an ancestor of the current working directory when the tern directory which is an ancestor of the current working directory when the tern
server is started. YCM starts the Tern server the first time a JavaScript file server is started. YCM starts the Tern server the first time a JavaScript file
is edited, so Vim's working directory at that time needs to be a descendent of is edited, so Vim's working directory at that time needs to be a descendent of
the directory containing the '.tern-project' file (or that directory itself). the directory containing the '.tern-project' file (or that directory itself).
Alternatively, as described in the Tern documentation [47], a global '.tern- Alternatively, as described in the Tern documentation [49], a global '.tern-
config' file may be used. config' file may be used.
Multiple Tern servers, are not supported. To switch to a different JavaScript Multiple Tern servers, are not supported. To switch to a different JavaScript
@ -1125,7 +1126,7 @@ project, you can do one of the following:
- start a new instance of Vim from the new project's directory - start a new instance of Vim from the new project's directory
- change Vim's working directory (':cd /path/to/new/project') and restart the - change Vim's working directory (':cd /path/to/new/project') and restart the
ycmd server [41] (|:YcmRestartServer|) ycmd server [43] (|:YcmRestartServer|)
- change Vim's working directory (':cd /path/to/new/project'), open a - change Vim's working directory (':cd /path/to/new/project'), open a
JavaScript file (or set filetype to JavaScript) and restart the Tern server JavaScript file (or set filetype to JavaScript) and restart the Tern server
@ -1137,9 +1138,9 @@ Tips and tricks ~
This section contains some advice for configuring '.tern-project' and working This section contains some advice for configuring '.tern-project' and working
with JavaScript files. The canonical reference for correctly configuring Tern with JavaScript files. The canonical reference for correctly configuring Tern
is the Tern documentation [47]. Any issues, improvements, advice, etc. should is the Tern documentation [49]. Any issues, improvements, advice, etc. should
be sought from the Tern [14] project. For example, see the list of tern plugins be sought from the Tern [16] project. For example, see the list of tern plugins
[48] for the list of plugins which can be enabled in the 'plugins' section of [50] for the list of plugins which can be enabled in the 'plugins' section of
the '.tern-project' file. the '.tern-project' file.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -1191,7 +1192,7 @@ Completions and GoTo commands within the current crate and its dependencies
should work out of the box with no additional configuration (provided that you should work out of the box with no additional configuration (provided that you
built YCM with the '--racer-completer' flag; see the _Installation_ section for built YCM with the '--racer-completer' flag; see the _Installation_ section for
details). For semantic analysis inclusive of the standard library, you must details). For semantic analysis inclusive of the standard library, you must
have a local copy of the rust source code [49]. You also need to set the have a local copy of the rust source code [51]. You also need to set the
following option so YouCompleteMe can locate it. following option so YouCompleteMe can locate it.
> >
" In this example, the rust source code zip has been extracted to " In this example, the rust source code zip has been extracted to
@ -1203,10 +1204,10 @@ following option so YouCompleteMe can locate it.
Python Semantic Completion ~ Python Semantic Completion ~
Completion and GoTo commands work out of the box with no additional Completion and GoTo commands work out of the box with no additional
configuration. Those features are provided by the jedi [8] library which configuration. Those features are provided by the jedi [10] library which
supports a variety of Python versions (2.6, 2.7, 3.2+) as long as it runs in supports a variety of Python versions (2.6, 2.7, 3.2+) as long as it runs in
the corresponding Python interpreter. By default YCM runs jedi [8] with the the corresponding Python interpreter. By default YCM runs jedi [10] with the
same Python interpreter used by the ycmd server [41], so if you would like to same Python interpreter used by the ycmd server [43], so if you would like to
use a different interpreter, use the following option specifying the Python use a different interpreter, use the following option specifying the Python
binary to use. For example, to provide Python 3 completion in your project, binary to use. For example, to provide Python 3 completion in your project,
set: set:
@ -1220,9 +1221,9 @@ the PATH. So for example if you set:
let g:ycm_python_binary_path = 'python' let g:ycm_python_binary_path = 'python'
< <
YCM will use the first 'python' executable it finds in the PATH to run jedi YCM will use the first 'python' executable it finds in the PATH to run jedi
[8]. This means that if you are in a virtual environment and you start vim in [10]. This means that if you are in a virtual environment and you start vim in
that directory, the first 'python' that YCM will find will be the one in the that directory, the first 'python' that YCM will find will be the one in the
virtual environment, so jedi [8] will be able to provide completions for every virtual environment, so jedi [10] will be able to provide completions for every
package you have in the virtual environment. package you have in the virtual environment.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -1230,8 +1231,8 @@ package you have in the virtual environment.
Semantic Completion for Other Languages ~ Semantic Completion for Other Languages ~
C-family, C#, Go, JavaScript, Python, Rust, and TypeScript languages are C-family, C#, Go, JavaScript, Python, Rust, and TypeScript languages are
supported natively by YouCompleteMe using the Clang [7], OmniSharp [10], Gocode supported natively by YouCompleteMe using the Clang [9], OmniSharp [12], Gocode
[11]/Godef [12], Tern [14], Jedi [8], racer [15], and TSServer [13] engines, [13]/Godef [14], Tern [16], Jedi [10], racer [17], and TSServer [15] engines,
respectively. Check the installation section for instructions to enable these respectively. Check the installation section for instructions to enable these
features if desired. features if desired.
@ -1240,7 +1241,7 @@ semantic completions if it does not have a native semantic completion engine
for your file's filetype. Vim comes with okayish omnifuncs for various for your file's filetype. Vim comes with okayish omnifuncs for various
languages like Ruby, PHP, etc. It depends on the language. languages like Ruby, PHP, etc. It depends on the language.
You can get stellar omnifuncs for Java and Ruby with Eclim [50]. Just make sure You can get stellar omnifuncs for Java and Ruby with Eclim [52]. Just make sure
you have the _latest_ Eclim installed and configured (this means Eclim '>= you have the _latest_ Eclim installed and configured (this means Eclim '>=
2.2.*' and Eclipse '>= 4.2.*'). 2.2.*' and Eclipse '>= 4.2.*').
@ -1258,7 +1259,7 @@ Writing New Semantic Completers ~
You have two options here: writing an 'omnifunc' for Vim's omnicomplete system You have two options here: writing an 'omnifunc' for Vim's omnicomplete system
that YCM will then use through its omni-completer, or a custom completer for that YCM will then use through its omni-completer, or a custom completer for
YCM using the Completer API [51]. YCM using the Completer API [53].
Here are the differences between the two approaches: Here are the differences between the two approaches:
@ -1277,7 +1278,7 @@ Here are the differences between the two approaches:
than VimScript. than VimScript.
If you want to use the 'omnifunc' system, see the relevant Vim docs with ':h If you want to use the 'omnifunc' system, see the relevant Vim docs with ':h
complete-functions'. For the Completer API, see the API docs [51]. complete-functions'. For the Completer API, see the API docs [53].
If you want to upstream your completer into YCM's source, you should use the If you want to upstream your completer into YCM's source, you should use the
Completer API. Completer API.
@ -1328,7 +1329,7 @@ current file in Vim's 'locationlist', which can be opened with the ':lopen' and
':lclose' commands (make sure you have set 'let ':lclose' commands (make sure you have set 'let
g:ycm_always_populate_location_list = 1' in your vimrc). A good way to toggle g:ycm_always_populate_location_list = 1' in your vimrc). A good way to toggle
the display of the 'locationlist' with a single key mapping is provided by the display of the 'locationlist' with a single key mapping is provided by
another (very small) Vim plugin called ListToggle [52] (which also makes it another (very small) Vim plugin called ListToggle [54] (which also makes it
possible to change the height of the 'locationlist' window), also written by possible to change the height of the 'locationlist' window), also written by
yours truly. yours truly.
@ -1370,7 +1371,7 @@ Commands ~
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *:YcmRestartServer* command The *:YcmRestartServer* command
If the ycmd completion server [41] suddenly stops for some reason, you can If the ycmd completion server [43] suddenly stops for some reason, you can
restart it with this command. restart it with this command.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -1418,7 +1419,7 @@ semantic completion engine.
The *:YcmToggleLogs* command The *:YcmToggleLogs* command
This command automatically opens in windows the stdout and stderr logfiles This command automatically opens in windows the stdout and stderr logfiles
written by the ycmd server [41]. If one or both logfiles are already opened, written by the ycmd server [43]. If one or both logfiles are already opened,
they are automatically closed. 'stderr' or 'stdout' can be specified as an they are automatically closed. 'stderr' or 'stdout' can be specified as an
argument of this command to only open the corresponding logfile instead of argument of this command to only open the corresponding logfile instead of
both. If this logfile is already opened, it will be closed. Only for debugging both. If this logfile is already opened, it will be closed. Only for debugging
@ -1809,7 +1810,7 @@ For example:
call youcompleteme#GetErrorCount() call youcompleteme#GetErrorCount()
< <
Both this function and |youcompleteme#GetWarningCount| can be useful when Both this function and |youcompleteme#GetWarningCount| can be useful when
integrating YCM with other Vim plugins. For example, a lightline [53] user integrating YCM with other Vim plugins. For example, a lightline [55] user
could add a diagnostics section to their statusline which would display the could add a diagnostics section to their statusline which would display the
number of errors and warnings. number of errors and warnings.
@ -1851,11 +1852,11 @@ Options ~
All options have reasonable defaults so if the plug-in works after installation All options have reasonable defaults so if the plug-in works after installation
you don't need to change any options. These options can be configured in your you don't need to change any options. These options can be configured in your
vimrc script [37] by including a line like this: vimrc script [39] by including a line like this:
> >
let g:ycm_min_num_of_chars_for_completion = 1 let g:ycm_min_num_of_chars_for_completion = 1
< <
Note that after changing an option in your vimrc script [37] you have to Note that after changing an option in your vimrc script [39] you have to
restart Vim for the changes to take effect. restart Vim for the changes to take effect.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -2096,13 +2097,13 @@ YCM will not render it.
The following filter types are supported: The following filter types are supported:
- "regex": Accepts a string regular expression [54]. This type matches when - "regex": Accepts a string regular expression [56]. This type matches when
the regex (treated as case-insensitive) is found in the diagnostic text. the regex (treated as case-insensitive) is found in the diagnostic text.
- "level": Accepts a string level, either "warning" or "error." This type - "level": Accepts a string level, either "warning" or "error." This type
matches when the diagnostic has the same level. matches when the diagnostic has the same level.
NOTE: The regex syntax is **NOT** Vim's, it's Python's [54]. NOTE: The regex syntax is **NOT** Vim's, it's Python's [56].
Default: '{}' Default: '{}'
> >
@ -2209,7 +2210,7 @@ from the 'tagfiles()' Vim function which examines the 'tags' Vim option. See
YCM will re-index your tags files if it detects that they have been modified. YCM will re-index your tags files if it detects that they have been modified.
The only supported tag format is the Exuberant Ctags format [55]. The format The only supported tag format is the Exuberant Ctags format [57]. The format
from "plain" ctags is NOT supported. Ctags needs to be called with the '-- from "plain" ctags is NOT supported. Ctags needs to be called with the '--
fields=+l' option (that's a lowercase 'L', not a one) because YCM needs the fields=+l' option (that's a lowercase 'L', not a one) because YCM needs the
'language:<lang>' field in the tags output. 'language:<lang>' field in the tags output.
@ -2246,7 +2247,7 @@ handy; it's a way of sending data from Vim to your 'FlagsForFile' function in
your '.ycm_extra_conf.py' file. your '.ycm_extra_conf.py' file.
This option is supposed to be a list of VimScript expression strings that are This option is supposed to be a list of VimScript expression strings that are
evaluated for every request to the ycmd server [41] and then passed to your evaluated for every request to the ycmd server [43] and then passed to your
'FlagsForFile' function as a 'client_data' keyword argument. 'FlagsForFile' function as a 'client_data' keyword argument.
For instance, if you set this option to "['v:version']", your 'FlagsForFile' For instance, if you set this option to "['v:version']", your 'FlagsForFile'
@ -2275,7 +2276,7 @@ YCM will by default search for an appropriate Python interpreter on your
system. You can use this option to override that behavior and force the use of system. You can use this option to override that behavior and force the use of
a specific interpreter of your choosing. a specific interpreter of your choosing.
NOTE: This interpreter is only used for the ycmd server [41]. The YCM client NOTE: This interpreter is only used for the ycmd server [43]. The YCM client
running inside Vim always uses the Python interpreter that's embedded inside running inside Vim always uses the Python interpreter that's embedded inside
Vim. Vim.
@ -2286,7 +2287,7 @@ Default: "''"
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *g:ycm_server_keep_logfiles* option The *g:ycm_server_keep_logfiles* option
When this option is set to '1', the ycmd completion server [41] will keep the When this option is set to '1', the ycmd completion server [43] will keep the
logfiles around after shutting down (they are deleted on shutdown by default). logfiles around after shutting down (they are deleted on shutdown by default).
To see where the logfiles are, call |:YcmDebugInfo|. To see where the logfiles are, call |:YcmDebugInfo|.
@ -2298,7 +2299,7 @@ Default: '0'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *g:ycm_server_log_level* option The *g:ycm_server_log_level* option
The logging level that the ycmd completion server [41] uses. Valid values are The logging level that the ycmd completion server [43] uses. Valid values are
the following, from most verbose to least verbose: - 'debug' - 'info' - the following, from most verbose to least verbose: - 'debug' - 'info' -
'warning' - 'error' - 'critical' 'warning' - 'error' - 'critical'
@ -2576,7 +2577,7 @@ It's also possible to use a regular expression as a trigger. You have to prefix
your trigger with 're!' to signify it's a regex trigger. For instance, your trigger with 're!' to signify it's a regex trigger. For instance,
're!\w+\.' would only trigger after the '\w+\.' regex matches. 're!\w+\.' would only trigger after the '\w+\.' regex matches.
NOTE: The regex syntax is **NOT** Vim's, it's Python's [54]. NOTE: The regex syntax is **NOT** Vim's, it's Python's [56].
Default: '[see next line]' Default: '[see next line]'
> >
@ -2644,9 +2645,9 @@ Default: 1000
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *g:ycm_python_binary_path* option The *g:ycm_python_binary_path* option
This option specifies the Python interpreter to use to run the jedi [8] This option specifies the Python interpreter to use to run the jedi [10]
completion library. Specify the Python interpreter to use to get completions. completion library. Specify the Python interpreter to use to get completions.
By default the Python under which ycmd [41] runs is used (ycmd [41] runs on By default the Python under which ycmd [43] runs is used (ycmd [43] runs on
Python 2.6, 2.7 or 3.3+). Python 2.6, 2.7 or 3.3+).
Default: "''" Default: "''"
@ -2665,7 +2666,7 @@ FAQ ~
I used to be able to 'import vim' in '.ycm_extra_conf.py', but now can't ~ I used to be able to 'import vim' in '.ycm_extra_conf.py', but now can't ~
YCM was rewritten to use a client-server architecture where most of the logic YCM was rewritten to use a client-server architecture where most of the logic
is in the ycmd server [41]. So the magic 'vim' module you could have previously is in the ycmd server [43]. So the magic 'vim' module you could have previously
imported in your '.ycm_extra_conf.py' files doesn't exist anymore. imported in your '.ycm_extra_conf.py' files doesn't exist anymore.
To be fair, importing the magic 'vim' module in extra conf files was never To be fair, importing the magic 'vim' module in extra conf files was never
@ -2740,7 +2741,7 @@ to the message log if it encounters problems. It's likely you misconfigured
something and YCM is complaining about it. something and YCM is complaining about it.
Also, you may want to run the |:YcmDebugInfo| command; it will make YCM spew Also, you may want to run the |:YcmDebugInfo| command; it will make YCM spew
out various debugging information, including the ycmd [41] logfile paths and out various debugging information, including the ycmd [43] logfile paths and
the compile flags for the current file if the file is a C-family language file the compile flags for the current file if the file is a C-family language file
and you have compiled in Clang support. Logfiles can be automatically opened in and you have compiled in Clang support. Logfiles can be automatically opened in
the editor using the |:YcmToggleLogs| command. the editor using the |:YcmToggleLogs| command.
@ -2795,7 +2796,7 @@ produced. See the full installation guide for help.
I'm trying to use a Homebrew Vim with YCM and I'm getting segfaults ~ I'm trying to use a Homebrew Vim with YCM and I'm getting segfaults ~
Something (I don't know what) is wrong with the way that Homebrew configures Something (I don't know what) is wrong with the way that Homebrew configures
and builds Vim. I recommend using MacVim [20]. Even if you don't like the and builds Vim. I recommend using MacVim [22]. Even if you don't like the
MacVim GUI, you can use the Vim binary that is inside the MacVim.app package MacVim GUI, you can use the Vim binary that is inside the MacVim.app package
(it's 'MacVim.app/Contents/MacOS/Vim') and get the Vim console experience. (it's 'MacVim.app/Contents/MacOS/Vim') and get the Vim console experience.
@ -2805,7 +2806,7 @@ I have a Homebrew Python and/or MacVim; can't compile/SIGABRT when starting ~
You should probably run 'brew rm python; brew install python' to get the latest You should probably run 'brew rm python; brew install python' to get the latest
fixes that should make YCM work with such a configuration. Also rebuild Macvim fixes that should make YCM work with such a configuration. Also rebuild Macvim
then. If you still get problems with this, see issue #18 [56] for suggestions. then. If you still get problems with this, see issue #18 [58] for suggestions.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*LONG_BIT-definition-appears-wrong-for-platform* *LONG_BIT-definition-appears-wrong-for-platform*
@ -2903,15 +2904,15 @@ YCM does not read identifiers from my tags files ~
First, put 'let g:ycm_collect_identifiers_from_tags_files = 1' in your vimrc. First, put 'let g:ycm_collect_identifiers_from_tags_files = 1' in your vimrc.
Make sure you are using Exuberant Ctags [57] to produce your tags files since Make sure you are using Exuberant Ctags [59] to produce your tags files since
the only supported tag format is the Exuberant Ctags format [55]. The format the only supported tag format is the Exuberant Ctags format [57]. The format
from "plain" ctags is NOT supported. The output of 'ctags --version' should from "plain" ctags is NOT supported. The output of 'ctags --version' should
list "Exuberant Ctags". list "Exuberant Ctags".
Ctags needs to be called with the '--fields=+l' (that's a lowercase 'L', not a Ctags needs to be called with the '--fields=+l' (that's a lowercase 'L', not a
one) option because YCM needs the 'language:<lang>' field in the tags output. one) option because YCM needs the 'language:<lang>' field in the tags output.
NOTE: Exuberant Ctags [57] by default sets language tag for '*.h' files as NOTE: Exuberant Ctags [59] by default sets language tag for '*.h' files as
'C++'. If you have C (not C++) project, consider giving parameter '-- 'C++'. If you have C (not C++) project, consider giving parameter '--
langmap=c:.c.h' to ctags to see tags from '*.h' files. langmap=c:.c.h' to ctags to see tags from '*.h' files.
@ -2993,7 +2994,7 @@ and similar, then just update to Vim 7.4.314 (or later) and they'll go away.
*vim-sub-autoclose* *vim-sub-autoclose*
Nasty bugs happen if I have the 'vim-autoclose' plugin installed ~ Nasty bugs happen if I have the 'vim-autoclose' plugin installed ~
Use the delimitMate [58] plugin instead. It does the same thing without Use the delimitMate [60] plugin instead. It does the same thing without
conflicting with YCM. conflicting with YCM.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -3001,7 +3002,7 @@ conflicting with YCM.
Is there some sort of YCM mailing list? I have questions ~ Is there some sort of YCM mailing list? I have questions ~
If you have questions about the plugin or need help, please use the ycm-users If you have questions about the plugin or need help, please use the ycm-users
[59] mailing list, _don't_ create issues on the tracker. The tracker is for bug [61] mailing list, _don't_ create issues on the tracker. The tracker is for bug
reports and feature requests. reports and feature requests.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
@ -3055,7 +3056,7 @@ mismatch in assumptions causes performance problems since Syntastic code isn't
optimized for this use case of constant diagnostic refreshing. optimized for this use case of constant diagnostic refreshing.
Poor support for this use case also led to crash bugs in Vim caused by Poor support for this use case also led to crash bugs in Vim caused by
Syntastic-Vim interactions (issue #593 [60]) and other problems, like random Syntastic-Vim interactions (issue #593 [62]) and other problems, like random
Vim flickering. Attempts were made to resolve these issues in Syntastic, but Vim flickering. Attempts were made to resolve these issues in Syntastic, but
ultimately some of them failed (for various reasons). ultimately some of them failed (for various reasons).
@ -3091,7 +3092,7 @@ paths, prepend '-isystem' to each individual path and append them all to the
list of flags you return from your 'FlagsForFile' function in your list of flags you return from your 'FlagsForFile' function in your
'.ycm_extra_conf.py' file. '.ycm_extra_conf.py' file.
See issue #303 [61] for details. See issue #303 [63] for details.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*.tern-sub-project* *.tern-sub-project*
@ -3110,7 +3111,7 @@ When I start vim I get a runtime error saying 'R6034 An application has made ~
an attempt to load the C runtime library incorrectly.' ~ an attempt to load the C runtime library incorrectly.' ~
CMake and other things seem to screw up the PATH with their own msvcrXX.dll CMake and other things seem to screw up the PATH with their own msvcrXX.dll
versions. [62] Add the following to the very top of your vimrc to remove these versions. [64] Add the following to the very top of your vimrc to remove these
entries from the path. entries from the path.
> >
python << EOF python << EOF
@ -3135,7 +3136,7 @@ entries from the path.
*youcompleteme-i-hear-that-ycm-only-supports-python-2-is-that-true* *youcompleteme-i-hear-that-ycm-only-supports-python-2-is-that-true*
I hear that YCM only supports Python 2, is that true? ~ I hear that YCM only supports Python 2, is that true? ~
**No.** Both the Vim client and the ycmd server [41] run on Python 2 or 3. If **No.** Both the Vim client and the ycmd server [43] run on Python 2 or 3. If
you work on a Python 3 project, you may need to set |g:ycm_python_binary_path| you work on a Python 3 project, you may need to set |g:ycm_python_binary_path|
to the Python interpreter you use for your project to get completions for that to the Python interpreter you use for your project to get completions for that
version of Python. version of Python.
@ -3146,37 +3147,37 @@ On Windows I get "E887: Sorry, this command is disabled, the Python's site ~
module could not be loaded" ~ module could not be loaded" ~
If you are running vim on Windows with Python 2.7.11, this is likely caused by If you are running vim on Windows with Python 2.7.11, this is likely caused by
a bug [63]. Follow this workaround [64] or use a different version (Python a bug [65]. Follow this workaround [66] or use a different version (Python
2.7.12 does not suffer from the bug). 2.7.12 does not suffer from the bug).
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-i-cant-complete-python-packages-in-virtual-environment.* *youcompleteme-i-cant-complete-python-packages-in-virtual-environment.*
I can't complete python packages in a virtual environment. ~ I can't complete python packages in a virtual environment. ~
This means that the Python used to run JediHTTP [9] is not the Python of the This means that the Python used to run JediHTTP [11] is not the Python of the
virtual environment you're in. To resolve this you either set virtual environment you're in. To resolve this you either set
|g:ycm_python_binary_path| to the absolute path of the Python binary in your |g:ycm_python_binary_path| to the absolute path of the Python binary in your
virtual environment or since virtual environment will put that Python virtual environment or since virtual environment will put that Python
executable first in your PATH when the virtual environment is active then if executable first in your PATH when the virtual environment is active then if
you set |g:ycm_python_binary_path| to just "'python'" it will be found as the you set |g:ycm_python_binary_path| to just "'python'" it will be found as the
first Python and used to run JediHTTP [9]. first Python and used to run JediHTTP [11].
=============================================================================== ===============================================================================
*youcompleteme-contributor-code-of-conduct* *youcompleteme-contributor-code-of-conduct*
Contributor Code of Conduct ~ Contributor Code of Conduct ~
Please note that this project is released with a Contributor Code of Conduct Please note that this project is released with a Contributor Code of Conduct
[65]. By participating in this project you agree to abide by its terms. [67]. By participating in this project you agree to abide by its terms.
=============================================================================== ===============================================================================
*youcompleteme-contact* *youcompleteme-contact*
Contact ~ Contact ~
If you have questions about the plugin or need help, please use the ycm-users If you have questions about the plugin or need help, please join the Gitter
[59] mailing list. room [1] or use the ycm-users [61] mailing list.
If you have bug reports or feature suggestions, please use the issue tracker If you have bug reports or feature suggestions, please use the issue tracker
[66]. [68].
The latest version of the plugin is available at The latest version of the plugin is available at
http://valloric.github.io/YouCompleteMe/. http://valloric.github.io/YouCompleteMe/.
@ -3187,79 +3188,81 @@ The author's homepage is http://val.markovic.io.
*youcompleteme-license* *youcompleteme-license*
License ~ License ~
This software is licensed under the GPL v3 license [67]. © 2015-2016 This software is licensed under the GPL v3 license [69]. © 2015-2016
YouCompleteMe contributors YouCompleteMe contributors
=============================================================================== ===============================================================================
*youcompleteme-references* *youcompleteme-references*
References ~ References ~
[1] https://travis-ci.org/Valloric/YouCompleteMe [1] https://gitter.im/Valloric/YouCompleteMe
[2] https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master [2] https://img.shields.io/gitter/room/Valloric/YouCompleteMe.svg
[3] https://ci.appveyor.com/project/Valloric/YouCompleteMe [3] https://travis-ci.org/Valloric/YouCompleteMe
[4] https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true [4] https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master
[5] https://codecov.io/gh/Valloric/YouCompleteMe [5] https://ci.appveyor.com/project/Valloric/YouCompleteMe
[6] https://codecov.io/gh/Valloric/YouCompleteMe/branch/master/graph/badge.svg [6] https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true
[7] http://clang.llvm.org/ [7] https://codecov.io/gh/Valloric/YouCompleteMe
[8] https://github.com/davidhalter/jedi [8] https://codecov.io/gh/Valloric/YouCompleteMe/branch/master/graph/badge.svg
[9] https://github.com/vheon/JediHTTP [9] http://clang.llvm.org/
[10] https://github.com/OmniSharp/omnisharp-server [10] https://github.com/davidhalter/jedi
[11] https://github.com/nsf/gocode [11] https://github.com/vheon/JediHTTP
[12] https://github.com/Manishearth/godef [12] https://github.com/OmniSharp/omnisharp-server
[13] https://github.com/Microsoft/TypeScript/tree/master/src/server [13] https://github.com/nsf/gocode
[14] http://ternjs.net [14] https://github.com/Manishearth/godef
[15] https://github.com/phildawes/racer [15] https://github.com/Microsoft/TypeScript/tree/master/src/server
[16] http://i.imgur.com/0OP4ood.gif [16] http://ternjs.net
[17] https://en.wikipedia.org/wiki/Subsequence [17] https://github.com/phildawes/racer
[18] https://github.com/scrooloose/syntastic [18] http://i.imgur.com/0OP4ood.gif
[19] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt [19] https://en.wikipedia.org/wiki/Subsequence
[20] https://github.com/macvim-dev/macvim/releases [20] https://github.com/scrooloose/syntastic
[21] https://github.com/VundleVim/Vundle.vim#about [21] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt
[22] http://brew.sh [22] https://github.com/macvim-dev/macvim/releases
[23] https://cmake.org/download/ [23] https://github.com/VundleVim/Vundle.vim#about
[24] http://www.mono-project.com/docs/getting-started/install/mac/ [24] http://brew.sh
[25] https://golang.org/doc/install [25] https://cmake.org/download/
[26] https://docs.npmjs.com/getting-started/installing-node [26] http://www.mono-project.com/docs/getting-started/install/mac/
[27] https://www.rust-lang.org/ [27] https://golang.org/doc/install
[28] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source [28] https://docs.npmjs.com/getting-started/installing-node
[29] http://www.mono-project.com/docs/getting-started/install/linux/#debian-ubuntu-and-derivatives [29] https://www.rust-lang.org/
[30] http://www.mono-project.com/docs/getting-started/install/linux/#centos-7-fedora-19-and-later-and-derivatives [30] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source
[31] https://bintray.com/micbou/generic/vim [31] http://www.mono-project.com/docs/getting-started/install/linux/#debian-ubuntu-and-derivatives
[32] https://www.python.org/downloads/windows/ [32] http://www.mono-project.com/docs/getting-started/install/linux/#centos-7-fedora-19-and-later-and-derivatives
[33] https://www.visualstudio.com/products/free-developer-offers-vs.aspx [33] https://bintray.com/micbou/generic/vim
[34] http://www.7-zip.org/download.html [34] https://www.python.org/downloads/windows/
[35] http://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1 [35] https://www.visualstudio.com/products/free-developer-offers-vs.aspx
[36] https://github.com/tpope/vim-pathogen#pathogenvim [36] http://www.7-zip.org/download.html
[37] http://vimhelp.appspot.com/starting.txt.html#vimrc [37] http://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1
[38] http://llvm.org/releases/download.html [38] https://github.com/tpope/vim-pathogen#pathogenvim
[39] http://www.mono-project.com/docs/getting-started/install/ [39] http://vimhelp.appspot.com/starting.txt.html#vimrc
[40] https://github.com/Valloric/YouCompleteMe#options [40] http://llvm.org/releases/download.html
[41] https://github.com/Valloric/ycmd [41] http://www.mono-project.com/docs/getting-started/install/
[42] https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py [42] https://github.com/Valloric/YouCompleteMe#options
[43] http://clang.llvm.org/docs/JSONCompilationDatabase.html [43] https://github.com/Valloric/ycmd
[44] https://github.com/rizsotto/Bear [44] https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py
[45] https://github.com/rdnetto/YCM-Generator [45] http://clang.llvm.org/docs/JSONCompilationDatabase.html
[46] http://ternjs.net/doc/manual.html#configuration [46] https://github.com/rizsotto/Bear
[47] http://ternjs.net/doc/manual.html#server [47] https://github.com/rdnetto/YCM-Generator
[48] http://ternjs.net/doc/manual.html#plugins [48] http://ternjs.net/doc/manual.html#configuration
[49] https://www.rust-lang.org/downloads.html [49] http://ternjs.net/doc/manual.html#server
[50] http://eclim.org/ [50] http://ternjs.net/doc/manual.html#plugins
[51] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py [51] https://www.rust-lang.org/downloads.html
[52] https://github.com/Valloric/ListToggle [52] http://eclim.org/
[53] https://github.com/itchyny/lightline.vim [53] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py
[54] https://docs.python.org/2/library/re.html#regular-expression-syntax [54] https://github.com/Valloric/ListToggle
[55] http://ctags.sourceforge.net/FORMAT [55] https://github.com/itchyny/lightline.vim
[56] https://github.com/Valloric/YouCompleteMe/issues/18 [56] https://docs.python.org/2/library/re.html#regular-expression-syntax
[57] http://ctags.sourceforge.net/ [57] http://ctags.sourceforge.net/FORMAT
[58] https://github.com/Raimondi/delimitMate [58] https://github.com/Valloric/YouCompleteMe/issues/18
[59] https://groups.google.com/forum/?hl=en#!forum/ycm-users [59] http://ctags.sourceforge.net/
[60] https://github.com/Valloric/YouCompleteMe/issues/593 [60] https://github.com/Raimondi/delimitMate
[61] https://github.com/Valloric/YouCompleteMe/issues/303 [61] https://groups.google.com/forum/?hl=en#!forum/ycm-users
[62] http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022 [62] https://github.com/Valloric/YouCompleteMe/issues/593
[63] https://github.com/vim/vim/issues/717 [63] https://github.com/Valloric/YouCompleteMe/issues/303
[64] https://github.com/vim/vim-win32-installer/blob/master/appveyor.bat#L90 [64] http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022
[65] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md [65] https://github.com/vim/vim/issues/717
[66] https://github.com/Valloric/YouCompleteMe/issues?state=open [66] https://github.com/vim/vim-win32-installer/blob/master/appveyor.bat#L90
[67] http://www.gnu.org/copyleft/gpl.html [67] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md
[68] https://github.com/Valloric/YouCompleteMe/issues?state=open
[69] http://www.gnu.org/copyleft/gpl.html
vim: ft=help vim: ft=help