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

Merge pull request #3403 from micbou/plugin-manager

Browse Source 
[READY] Add back Vundle instruction in macOS section
This commit is contained in:
mergify[bot] 2019-05-11 15:18:19 +00:00 committed by GitHub
commit dbcc3b0e14
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -175,6 +175,8 @@ with [Homebrew][brew]. Install CMake as well:
brew install cmake macvim brew install cmake macvim
Install YouCompleteMe with [Vundle][].
**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 using Vundle and the ycm_core library APIs have changed (happens
rarely), YCM will notify you to recompile it. You should then rerun the install rarely), YCM will notify you to recompile it. You should then rerun the install

76
doc/youcompleteme.txt
View File

@ -377,6 +377,8 @@ it with Homebrew [21]. Install CMake as well:
> >
brew install cmake macvim brew install cmake macvim
< <
Install YouCompleteMe with Vundle [22].
**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
will notify you to recompile it. You should then rerun the install process. will notify you to recompile it. You should then rerun the install process.
@ -412,18 +414,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: install Mono with Homebrew [21] or by downloading the Mono - C# support: install Mono with Homebrew [21] or by downloading the Mono
macOS package [22] and add '--cs-completer' when calling 'install.py'. macOS package [23] and add '--cs-completer' when calling 'install.py'.
- Go support: install Go [23] and add '--go-completer' when calling - Go support: install Go [24] and add '--go-completer' when calling
'install.py'. 'install.py'.
- JavaScript and TypeScript support: install Node.js and npm [24] and add - JavaScript and TypeScript support: install Node.js and npm [25] and add
'--ts-completer' when calling 'install.py'. '--ts-completer' when calling 'install.py'.
- Rust support: install Rust [25] and add '--rust-completer' when calling - Rust support: install Rust [26] and add '--rust-completer' when calling
'install.py'. 'install.py'.
- Java support: install JDK8 (version 8 required) [26] and add - Java support: install JDK8 (version 8 required) [27] and add
'--java-completer' when calling 'install.py'. '--java-completer' when calling 'install.py'.
To simply compile with everything enabled, there's a '--all' flag. Note that To simply compile with everything enabled, there's a '--all' flag. Note that
@ -456,9 +458,9 @@ Make sure you have Vim 7.4.1578 with Python 2 or Python 3 support. The Vim
package on Fedora 27 and later and the pre-installed Vim on Ubuntu 16.04 and package on Fedora 27 and later and the pre-installed Vim on Ubuntu 16.04 and
later are recent enough. You can see the version of Vim installed by running later are 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 Vim from 'vim --version'. If the version is too old, you may need to compile Vim from
source [27] (don't worry, it's easy). source [28] (don't worry, it's easy).
Install YouCompleteMe with Vundle [28]. Install YouCompleteMe with Vundle [22].
**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
@ -482,13 +484,13 @@ Compiling YCM **with** semantic support for C-family languages through
**libclang**: **libclang**:
> >
cd ~/.vim/bundle/YouCompleteMe cd ~/.vim/bundle/YouCompleteMe
./install.py --clang-completer python3 install.py --clang-completer
< <
Compiling YCM **with** semantic support for C-family languages through Compiling YCM **with** semantic support for C-family languages through
**experimental clangd**: **experimental clangd**:
> >
cd ~/.vim/bundle/YouCompleteMe cd ~/.vim/bundle/YouCompleteMe
./install.py --clangd-completer python3 install.py --clangd-completer
< <
Note that you can install YCM with both **libclang** and **clangd** enabled. In Note that you can install YCM with both **libclang** and **clangd** enabled. In
that case **clangd** will be preferred unless you have the following in your that case **clangd** will be preferred unless you have the following in your
@ -506,16 +508,16 @@ The following additional language support options are available:
- C# support: install Mono [29] and add '--cs-completer' when calling - C# support: install Mono [29] and add '--cs-completer' when calling
'install.py'. 'install.py'.
- Go support: install Go [23] and add '--go-completer' when calling - Go support: install Go [24] and add '--go-completer' when calling
'install.py'. 'install.py'.
- JavaScript and TypeScript support: install Node.js and npm [24] and add - JavaScript and TypeScript support: install Node.js and npm [25] and add
'--ts-completer' when calling 'install.py'. '--ts-completer' when calling 'install.py'.
- Rust support: install Rust [25] and add '--rust-completer' when calling - Rust support: install Rust [26] and add '--rust-completer' when calling
'install.py'. 'install.py'.
- Java support: install JDK8 (version 8 required) [26] and add - Java support: install JDK8 (version 8 required) [27] and add
'--java-completer' when calling 'install.py'. '--java-completer' when calling 'install.py'.
To simply compile with everything enabled, there's a '--all' flag. Note that To simply compile with everything enabled, there's a '--all' flag. Note that
@ -564,7 +566,7 @@ that it does not prevent you from editing a file in another encoding than
UTF-8. You can do that by specifying the '|++enc|' argument to the ':e' UTF-8. You can do that by specifying the '|++enc|' argument to the ':e'
command. command.
Install YouCompleteMe with Vundle [28]. Install YouCompleteMe with Vundle [22].
**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
@ -617,16 +619,16 @@ The following additional language support options are available:
- C# support: add '--cs-completer' when calling 'install.py'. Be sure that - C# support: add '--cs-completer' when calling 'install.py'. Be sure that
the build utility 'msbuild' is in your PATH [35]. the build utility 'msbuild' is in your PATH [35].
- Go support: install Go [23] and add '--go-completer' when calling - Go support: install Go [24] and add '--go-completer' when calling
'install.py'. 'install.py'.
- JavaScript and TypeScript support: install Node.js and npm [24] and add - JavaScript and TypeScript support: install Node.js and npm [25] and add
'--ts-completer' when calling 'install.py'. '--ts-completer' when calling 'install.py'.
- Rust support: install Rust [25] and add '--rust-completer' when calling - Rust support: install Rust [26] and add '--rust-completer' when calling
'install.py'. 'install.py'.
- Java support: install JDK8 (version 8 required) [26] and add - Java support: install JDK8 (version 8 required) [27] and add
'--java-completer' when calling 'install.py'. '--java-completer' when calling 'install.py'.
To simply compile with everything enabled, there's a '--all' flag. Note that To simply compile with everything enabled, there's a '--all' flag. Note that
@ -669,7 +671,7 @@ For FreeBSD 11.x, the requirement is cmake:
> >
pkg install cmake pkg install cmake
< <
Install YouCompleteMe with Vundle [28]. Install YouCompleteMe with Vundle [22].
**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
@ -708,16 +710,16 @@ The following additional language support options are available:
- C# support: install Mono and add '--cs-completer' when calling - C# support: install Mono and add '--cs-completer' when calling
'./install.py'. './install.py'.
- Go support: install Go [23] and add '--go-completer' when calling - Go support: install Go [24] and add '--go-completer' when calling
'./install.py'. './install.py'.
- JavaScript and TypeScript support: install Node.js and npm [24] and add - JavaScript and TypeScript support: install Node.js and npm [25] and add
'--ts-completer' when calling 'install.py'. '--ts-completer' when calling 'install.py'.
- Rust support: install Rust [25] and add '--rust-completer' when calling - Rust support: install Rust [26] and add '--rust-completer' when calling
'./install.py'. './install.py'.
- Java support: install JDK8 (version 8 required) [26] and add - Java support: install JDK8 (version 8 required) [27] and add
'--java-completer' when calling './install.py'. '--java-completer' when calling './install.py'.
To simply compile with everything enabled, there's a '--all' flag. Note that To simply compile with everything enabled, there's a '--all' flag. Note that
@ -769,7 +771,7 @@ will notify you to recompile it. You should then rerun the install process.
higher. 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 [27] (don't worry, it's easy). from source [28] (don't worry, it's easy).
After you have made sure that you have Vim 7.4.1578+, type the following After you have made sure that you have Vim 7.4.1578+, 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.
@ -779,7 +781,7 @@ 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 [28] (or Pathogen [36], but Vundle is a 2. **Install YCM** with Vundle [22] (or Pathogen [36], 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 [31]. 'Valloric/YouCompleteMe'" line to your vimrc [31].
@ -942,7 +944,7 @@ will notify you to recompile it. You should then rerun the install process.
On Windows, be sure that the build utility 'msbuild' is in your PATH On Windows, be sure that the build utility 'msbuild' is in your PATH
[35]. [35].
- Go support: install Go [23] and add it to your path. Navigate to - Go support: install Go [24] and add it to your path. Navigate to
'YouCompleteMe/third_party/ycmd/third_party/go' and in **both** 'YouCompleteMe/third_party/ycmd/third_party/go' and in **both**
'src/github.com/mdempsky/gocode' and 'src/github.com/rogpeppe/godef' 'src/github.com/mdempsky/gocode' and 'src/github.com/rogpeppe/godef'
run run
@ -953,15 +955,15 @@ will notify you to recompile it. You should then rerun the install process.
'YouCompleteMe/third_party/ycmd/third_party/go' then run 'go build' in 'YouCompleteMe/third_party/ycmd/third_party/go' then run 'go build' in
the two directories above. the two directories above.
- JavaScript and TypeScript support: install Node.js and npm [24], - JavaScript and TypeScript support: install Node.js and npm [25],
navigate to 'YouCompleteMe/third_party/ycmd' and run 'npm install -g navigate to 'YouCompleteMe/third_party/ycmd' and run 'npm install -g
--prefix third_party/tsserver typescript'. --prefix third_party/tsserver typescript'.
- Rust support: install Rust [25]. Navigate to - Rust support: install Rust [26]. 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'.
- Java support: install JDK8 (version 8 required) [26]. Download a - Java support: install JDK8 (version 8 required) [27]. Download a
binary release of eclipse.jdt.ls [41] and extract it to 'YouCompleteM binary release of eclipse.jdt.ls [41] and extract it to 'YouCompleteM
e/third_party/ycmd/third_party/eclipse.jdt.ls/target/repository'. e/third_party/ycmd/third_party/eclipse.jdt.ls/target/repository'.
Note: this approach is not recommended for most users and is Note: this approach is not recommended for most users and is
@ -1652,7 +1654,7 @@ available on the wiki [63].
All JavaScript and TypeScript features are provided by the TSServer [13] All JavaScript and TypeScript features are provided by the TSServer [13]
engine, which is included in the TypeScript SDK. To enable these features, engine, which is included in the TypeScript SDK. To enable these features,
install Node.js and npm [24] and call the 'install.py' script with the install Node.js and npm [25] and call the 'install.py' script with the
'--ts-completer' flag. '--ts-completer' flag.
TSServer [13] relies on the 'jsconfig.json' file [64] for JavaScript and the TSServer [13] relies on the 'jsconfig.json' file [64] for JavaScript and the
@ -3838,13 +3840,13 @@ References ~
[19] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt [19] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt
[20] https://macvim-dev.github.io/macvim/ [20] https://macvim-dev.github.io/macvim/
[21] http://brew.sh [21] http://brew.sh
[22] http://www.mono-project.com/docs/getting-started/install/mac/ [22] https://github.com/VundleVim/Vundle.vim#about
[23] https://golang.org/doc/install [23] http://www.mono-project.com/docs/getting-started/install/mac/
[24] https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm [24] https://golang.org/doc/install
[25] https://www.rust-lang.org/ [25] https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm
[26] http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html [26] https://www.rust-lang.org/
[27] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source [27] http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
[28] https://github.com/VundleVim/Vundle.vim#about [28] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source
[29] https://www.mono-project.com/download/stable/#download-lin [29] https://www.mono-project.com/download/stable/#download-lin
[30] https://github.com/vim/vim-win32-installer/releases [30] https://github.com/vim/vim-win32-installer/releases
[31] http://vimhelp.appspot.com/starting.txt.html#vimrc [31] http://vimhelp.appspot.com/starting.txt.html#vimrc