diff --git a/README.md b/README.md index 3b506ec4a7..1bb08b0db9 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,10 @@ YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for - a [clangd][]-based **experimental** completion engine for the C-family languages. - a [Jedi][]-based completion engine for Python 2 and 3, -- an [OmniSharp][]-based completion engine for C#, -- a combination of [Gocode][] and [Godef][] semantic engines for Go, +- an [OmniSharp-Roslyn][]-based completion engine for C#, +- a [Gopls][]-based completion engine for Go, - a [TSServer][]-based completion engine for JavaScript and TypeScript, -- a [racer][]-based completion engine for Rust, +- a [rls][]-based completion engine for Rust, - a [jdt.ls][]-based experimental completion engine for Java. - and an omnifunc-based completer that uses data from Vim's omnicomplete system to provide semantic completions for many other languages (Ruby, PHP etc.). @@ -221,15 +221,16 @@ The following additional language support options are available: `install.py`. - JavaScript and TypeScript support: install [Node.js and npm][npm-install] and add `--ts-completer` when calling `install.py`. -- Rust support: install [Rust][rust-install] and add - `--rust-completer` when calling `install.py`. +- Rust support: add `--rust-completer` when calling `install.py`. + - If your Python interpreter is older than 2.7.9, you will also need + [rustup][] in your `PATH`. - Java support: install [JDK8 (version 8 required)][jdk-install] and add `--java-completer` when calling `install.py`. To simply compile with everything enabled, there's a `--all` flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding `--clangd-completer`. So, to install with all language features, ensure -`xbuild`, `go`, `tsserver`, `node`, `npm`, `rustc`, and `cargo` tools are +`xbuild`, `go`, `tsserver`, `node` and `npm` tools are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe @@ -310,15 +311,16 @@ The following additional language support options are available: `install.py`. - JavaScript and TypeScript support: install [Node.js and npm][npm-install] and add `--ts-completer` when calling `install.py`. -- Rust support: install [Rust][rust-install] and add `--rust-completer` when - calling `install.py`. +- Rust support: add `--rust-completer` when calling `install.py`. + - If your Python interpreter is older than 2.7.9, you will also need + [rustup][] in your `PATH`. - Java support: install [JDK8 (version 8 required)][jdk-install] and add `--java-completer` when calling `install.py`. To simply compile with everything enabled, there's a `--all` flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding `--clangd-completer`. So, to install with all language features, ensure -`xbuild`, `go`, `tsserver`, `node`, `npm`, `rustc`, and `cargo` tools are +`xbuild`, `go`, `tsserver`, `node`, `npm` and tools are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe @@ -417,15 +419,16 @@ The following additional language support options are available: `install.py`. - JavaScript and TypeScript support: install [Node.js and npm][npm-install] and add `--ts-completer` when calling `install.py`. -- Rust support: install [Rust][rust-install] and add `--rust-completer` when - calling `install.py`. +- Rust support: add `--rust-completer` when calling `install.py`. + - If your Python interpreter is older than 2.7.9, you will also need + [rustup][] in your `PATH`. - Java support: install [JDK8 (version 8 required)][jdk-install] and add `--java-completer` when calling `install.py`. To simply compile with everything enabled, there's a `--all` flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding `--clangd-completer`. So, to install with all language features, ensure -`msbuild`, `go`, `tsserver`, `node`, `npm`, and `cargo` tools are installed and +`msbuild`, `go`, `tsserver`, `node` and `npm` tools are installed and in your `PATH`, then simply run: cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe @@ -506,15 +509,16 @@ The following additional language support options are available: `./install.py`. - JavaScript and TypeScript support: install [Node.js and npm][npm-install] and add `--ts-completer` when calling `install.py`. -- Rust support: install [Rust][rust-install] and add `--rust-completer` when - calling `./install.py`. +- Rust support: add `--rust-completer` when calling `./install.py`. + - If your Python interpreter is older than 2.7.9, you will also need + [rustup][] in your `PATH`. - Java support: install [JDK8 (version 8 required)][jdk-install] and add `--java-completer` when calling `./install.py`. To simply compile with everything enabled, there's a `--all` flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding `--clangd-completer`. So, to install with all language features, ensure -`xbuild`, `go`, `tsserver`, `node`, `npm`, `rustc`, and `cargo` tools are +`xbuild`, `go`, `tsserver`, `node`, `npm` and tools are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe @@ -723,31 +727,36 @@ process. 6. Set up support for additional languages, as desired: - C# support: install [Mono on non-Windows platforms][mono-install]. - Navigate to `YouCompleteMe/third_party/ycmd/third_party/OmniSharpServer` - and run - - msbuild /property:Configuration=Release /property:Platform="Any CPU" /property:TargetFrameworkVersion=v4.5 + Navigate to `YouCompleteMe/third_party/ycmd/third_party/omnisharp-roslyn`. + Download an [Omnisharp-Roslyn release archive][roslyn-releases] and + extract the archive to + `YouCompleteMe/third_party/ycmd/third_party/omnisharp-roslyn`. On Windows, be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path]. - Go support: install [Go][go-install] and add it to your path. Navigate to - `YouCompleteMe/third_party/ycmd/third_party/go` and in **both** - `src/github.com/mdempsky/gocode` and `src/github.com/rogpeppe/godef` run - - GOPATH=$(realpath ../../../..) go build + `YouCompleteMe/third_party/ycmd/third_party/go/src/golang.org/x/tools/cmd/gopls` + and run - On Windows, first set `GOPATH` to the absolute path of - `YouCompleteMe/third_party/ycmd/third_party/go` then run `go build` in the two - directories above. + go build - JavaScript and TypeScript support: install [Node.js and npm][npm-install], navigate to `YouCompleteMe/third_party/ycmd` and run `npm install -g --prefix third_party/tsserver typescript`. - - Rust support: install [Rust][rust-install]. Navigate to - `YouCompleteMe/third_party/ycmd/third_party/racerd` and run `cargo build - --release`. + - Rust support: install [rustup][]. Export `RUSTUP_HOME` environment + variable and point it to an empty temporary directory. + Run the following commands: + + rustup toolchain install nightly + rustup default nightly + rustup component add rls rust-analysis rust-src + + Ensure that `YouCompleteMe/third_party/ycmd/third_party/rls` directory + exists and is empty. Go into the temporary directory and then into + `toolchains/`. Finally, move everything from that directory to + `YouCompleteMe/third_party/ycmd/third_party/rls`. - Java support: install [JDK8 (version 8 required)][jdk-install]. Download a [binary release of eclipse.jdt.ls][jdtls-release] and extract it to @@ -790,10 +799,11 @@ Quick Feature Summary * Semantic auto-completion * Real-time diagnostic display * Go to declaration/definition (`GoTo`, etc.) +* Go to implementation (`GoToImplementation`) * View documentation comments for identifiers (`GetDoc`) * Type information for identifiers (`GetType`) * Automatically fix certain errors (`FixIt`) -* Management of OmniSharp server instance +* Management of OmniSharp-Roslyn server instance ### Python @@ -806,8 +816,13 @@ Quick Feature Summary ### Go * Semantic auto-completion -* Go to definition (`GoTo`) -* Management of `gocode` server instance +* Real-time diagnostic display +* Go to declaration/definition (`GoTo`, etc.) +* Go to type definition (`GoToType`) +* Automatically fix certain errors (`FixIt`) +* Type information for identifiers (`GetType`) +* Code formatting (`Format`) +* Management of `gopls` server instance ### JavaScript and TypeScript @@ -828,10 +843,16 @@ Quick Feature Summary ### Rust * Semantic auto-completion -* Go to definition (`GoTo`, `GoToDefinition`, and `GoToDeclaration` are - identical) +* Real-time diagnostic display +* Go to declaration/definition (`GoTo`, etc.) +* Go to implementation (`GoToImplementation`) +* Reference finding (`GoToReferences`) * View documentation comments for identifiers (`GetDoc`) -* Management of `racer` server instance +* Type information for identifiers (`GetType`) +* Renaming symbols (`RefactorRename `) +* Code formatting (`Format`) +* Execute custom server command (`ExecuteCommand `) +* Management of `rls` server instance ### Java @@ -852,6 +873,7 @@ Quick Feature Summary * Code formatting (`Format`) * Organize imports (`OrganizeImports`) * Detection of java projects +* Execute custom server command (`ExecuteCommand `) * Management of `jdt.ls` server instance User Guide @@ -1018,9 +1040,6 @@ directory. #### Option 2: Provide the flags manually -_Note that this option doesn't work with **experimental** [clangd][]-based -completer. You can use a [compile_flags.txt][fixedcdb] file instead._ - If you don't have a compilation database, or aren't able to generate one, you have to tell YouCompleteMe how to compile your code some other way. @@ -1395,20 +1414,10 @@ setting one of the options. YCM will automatically pick the new values. Completions and GoTo commands within the current crate and its dependencies should work out of the box with no additional configuration (provided that you built YCM with the `--rust-completer` flag; see the [*Installation* -section](#installation) for details). For semantic analysis inclusive of the -standard library, you must have a local copy of [the Rust source -code][rust-src]. If using [rustup][], run the following command to download the -code: -``` -rustup component add rust-src -``` -YCM will find its location automatically. Otherwise, download the archive, -extract it somewhere, and set the following option so YCM can locate it: -```viml -" In this example, the Rust source code archive has been extracted to -" /usr/local/rust/rustc-1.20.0 -let g:ycm_rust_src_path = '/usr/local/rust/rustc-1.20.0/src' -``` +section](#installation) for details). The install script takes care of +installing [the Rust source code][rust-src], so no configuration is necessary. +In case you are running Python 2.7.8 and older, you will need to manually +install [rustup][]. ### JavaScript and TypeScript Semantic Completion @@ -1444,8 +1453,8 @@ To get diagnostics in JavaScript, set the `checkJs` option to `true` in your ### Semantic Completion for Other Languages C-family, C#, Go, Java, Python, Rust, and JavaScript/TypeScript languages are -supported natively by YouCompleteMe using the [Clang][], [OmniSharp][], -[Gocode][]/[Godef][], [jdt.ls][], [Jedi][], [racer][], and [TSServer][] engines, +supported natively by YouCompleteMe using the [Clang][], [OmniSharp-Roslyn][], +[Gopls][], [jdt.ls][], [Jedi][], [rls][], and [TSServer][] engines, respectively. Check the [installation](#installation) section for instructions to enable these features if desired. @@ -1492,10 +1501,10 @@ Completer API. ### Diagnostic Display -YCM will display diagnostic notifications for the C-family, C#, Java, -JavaScript, and TypeScript languages. Since YCM continuously recompiles your -file as you type, you'll get notified of errors and warnings in your file as -fast as possible. +YCM will display diagnostic notifications for the C-family, C#, Go, Java, +JavaScript, Rust and TypeScript languages. Since YCM continuously recompiles +your file as you type, you'll get notified of errors and warnings in your file +as fast as possible. Here are the various pieces of the diagnostic UI: @@ -1734,7 +1743,7 @@ This command attempts to find all of the references within the project to the identifier under the cursor and populates the quickfix list with those locations. -Supported in filetypes: `java, javascript, python, typescript` +Supported in filetypes: `java, javascript, python, typescript, rust` #### The `GoToImplementation` subcommand @@ -1742,7 +1751,7 @@ Looks up the symbol under the cursor and jumps to its implementation (i.e. non-interface). If there are multiple implementations, instead provides a list of implementations to choose from. -Supported in filetypes: `cs, java` +Supported in filetypes: `cs, java, rust` #### The `GoToImplementationElseDeclaration` subcommand @@ -1757,7 +1766,7 @@ Supported in filetypes: `cs` Looks up the symbol under the cursor and jumps to the definition of its type e.g. if the symbol is an object, go to the definition of its class. -Supported in filetypes: `java, javascript, typescript` +Supported in filetypes: `go, java, javascript, typescript` ### Semantic Information Commands @@ -1780,7 +1789,7 @@ Invoking this command on `s` returns `std::string => std::basic_string` **NOTE:** Causes re-parsing of the current translation unit. Supported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, -python, typescript` +go, python, typescript, rust` #### The `GetTypeImprecise` subcommand @@ -1885,7 +1894,7 @@ indication). **NOTE:** Causes re-parsing of the current translation unit. -Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, java, javascript, +Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript, typescript` #### The `RefactorRename ` subcommand @@ -1900,7 +1909,7 @@ files. Rename operations may involve changes to multiple files, which may or may not be open in Vim buffers at the time. YouCompleteMe handles all of this for you. The behavior is described in [the following section](#multi-file-refactor). -Supported in filetypes: `java, javascript, typescript` +Supported in filetypes: `java, javascript, typescript, rust` #### Multi-file Refactor @@ -1941,7 +1950,7 @@ it in one of Vim's visual modes (see `:h visual-use`) and run the command or directly enter the range on the command line, e.g. `:2,5YcmCompleter Format` to format it from line 2 to line 5. -Supported in filetypes: `java, javascript, typescript` +Supported in filetypes: `java, javascript, go, typescript, rust` #### The `OrganizeImports` subcommand @@ -1957,6 +1966,16 @@ These commands are for general administration, rather than IDE-like features. They cover things like the semantic engine server instance and compilation flags. +#### The `ExecuteCommand ` subcommand + +Some LSP completers (currently Rust and Java completers) support executing +server specific commands. Consult the [rls][] and [jdt.ls][] respective +documentations to find out what commands are supported and which arguments are +expected. + +The support for `ExecuteCommand` was implemented to support plugins like +[vimspector][] to debug java, but isn't limited to that specific use case. + #### The `RestartServer` subcommand Restarts the semantic-engine-as-localhost-server for those semantic engines that @@ -1975,13 +1994,14 @@ the server with the `:YcmRestartServer` command). This command clears that cache entirely. YCM will then re-query your `Settings` function or your compilation database as needed in the future. -Supported in filetypes: `c, cpp, objc, objcpp, cuda` +Supported in filetypes: `c, cpp, objc, objcpp, cuda, rust` #### The `ReloadSolution` subcommand -Instruct the Omnisharp server to clear its cache and reload all files from disk. -This is useful when files are added, removed, or renamed in the solution, files -are changed outside of Vim, or whenever Omnisharp cache is out-of-sync. +Instruct the Omnisharp-Roslyn server to clear its cache and reload all files +from disk. This is useful when files are added, removed, or renamed in the +solution, files are changed outside of Vim, or whenever Omnisharp-Roslyn cache +is out-of-sync. Supported in filetypes: `cs` @@ -2599,8 +2619,8 @@ let g:ycm_log_level = 'info' ### The `g:ycm_auto_start_csharp_server` option -When set to `1`, the OmniSharp server will be automatically started (once per -Vim session) when you open a C# file. +When set to `1`, the OmniSharp-Roslyn server will be automatically started +(once per Vim session) when you open a C# file. Default: `1` @@ -2610,7 +2630,7 @@ let g:ycm_auto_start_csharp_server = 1 ### The `g:ycm_auto_stop_csharp_server` option -When set to `1`, the OmniSharp server will be automatically stopped upon +When set to `1`, the OmniSharp-Roslyn server will be automatically stopped upon closing Vim. Default: `1` @@ -2622,7 +2642,7 @@ let g:ycm_auto_stop_csharp_server = 1 ### The `g:ycm_csharp_server_port` option When g:ycm_auto_start_csharp_server is set to `1`, specifies the port for -the OmniSharp server to listen on. When set to `0` uses an unused port provided +the OmniSharp-Roslyn server to listen on. When set to `0` uses an unused port provided by the OS. Default: `0` @@ -3038,6 +3058,16 @@ Default: `1` let g:ycm_clangd_uses_ycmd_caching = 1 ``` +### The `g:ycm_java_jdtls_extension_path` option + +This option declares a list of paths where a jdt.ls extension can be found. + +Default: `[]` + +```viml +let g:ycm_java_jdtls_extension_path = [] +``` + FAQ --- @@ -3592,7 +3622,7 @@ This software is licensed under the [GPL v3 license][gpl]. [ctags-format]: http://ctags.sourceforge.net/FORMAT [vundle-bug]: https://github.com/VundleVim/Vundle.vim/issues/48 [ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users -[omnisharp]: https://github.com/OmniSharp/omnisharp-server +[omnisharp-roslyn]: https://github.com/OmniSharp/omnisharp-roslyn [issue-303]: https://github.com/Valloric/YouCompleteMe/issues/303 [issue-593]: https://github.com/Valloric/YouCompleteMe/issues/593 [issue-669]: https://github.com/Valloric/YouCompleteMe/issues/669 @@ -3600,8 +3630,7 @@ This software is licensed under the [GPL v3 license][gpl]. [python-re]: https://docs.python.org/2/library/re.html#regular-expression-syntax [Bear]: https://github.com/rizsotto/Bear [ygen]: https://github.com/rdnetto/YCM-Generator -[Gocode]: https://github.com/nsf/gocode -[Godef]: https://github.com/Manishearth/godef +[Gopls]: https://github.com/golang/go/wiki/gopls [TSServer]: https://github.com/Microsoft/TypeScript/tree/master/src/server [jsconfig.json]: https://code.visualstudio.com/docs/languages/jsconfig [tsconfig.json]: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html @@ -3616,8 +3645,7 @@ This software is licensed under the [GPL v3 license][gpl]. [npm-install]: https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm [tern-instructions]: https://github.com/Valloric/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern [Tern]: http://ternjs.net -[racer]: https://github.com/phildawes/racer -[rust-install]: https://www.rust-lang.org/ +[rls]: https://github.com/rust-lang/rls [rust-src]: https://www.rust-lang.org/downloads.html [add-msbuild-to-path]: http://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1 [identify-R6034-cause]: http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022 @@ -3645,3 +3673,5 @@ This software is licensed under the [GPL v3 license][gpl]. [clangd]: https://clang.llvm.org/extra/clangd.html [fixedcdb]: https://clang.llvm.org/docs/JSONCompilationDatabase.html#alternatives [clangd-indexing]: https://clang.llvm.org/extra/clangd.html#project-wide-indexing +[vimspector]: https://github.com/puremourning/vimspector +[roslyn-releases]: https://github.com/OmniSharp/omnisharp-roslyn/releases diff --git a/azure-pipelines.yml b/azure-pipelines.yml index d61dd3e3cc..7ae8130b90 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -64,7 +64,7 @@ jobs: pool: # List of available software on this image: # https://github.com/Microsoft/azure-pipelines-image-generation/blob/master/images/win/Vs2017-Server2016-Readme.md - vmImage: 'vs2017-win2016' + vmImage: 'windows-2019' strategy: matrix: # We only test Python 2.7 on 64-bit. diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt index c79cecb762..6b36245c15 100644 --- a/doc/youcompleteme.txt +++ b/doc/youcompleteme.txt @@ -1,4 +1,4 @@ -*youcompleteme* YouCompleteMe: a code-completion engine for Vim +*youcompleteme.txt* YouCompleteMe: a code-completion engine for Vim =============================================================================== Contents ~ @@ -83,9 +83,10 @@ Contents ~ 4. The |Format| subcommand 5. The |OrganizeImports| subcommand 4. Miscellaneous Commands |youcompleteme-miscellaneous-commands| - 1. The |RestartServer| subcommand - 2. The |ClearCompilationFlagCache| subcommand - 3. The |ReloadSolution| subcommand + 1. The 'ExecuteCommand ' subcommand |ExecuteCommand-args| + 2. The |RestartServer| subcommand + 3. The |ClearCompilationFlagCache| subcommand + 4. The |ReloadSolution| subcommand 10. Functions |youcompleteme-functions| 1. The |youcompleteme#GetErrorCount| function 2. The |youcompleteme#GetWarningCount| function @@ -146,6 +147,7 @@ Contents ~ 51. The |g:ycm_clangd_binary_path| option 52. The |g:ycm_clangd_args| option 53. The |g:ycm_clangd_uses_ycmd_caching| option + 54. The |g:ycm_java_jdtls_extension_path| option 13. FAQ |youcompleteme-faq| 1. I used to be able to 'import vim' in '.ycm_extra_conf.py', but now can't |youcompleteme-i-used-to-be-able-to-import-vim-in-.ycm_extra_conf.py-but-now-cant| 2. I get 'ImportError' exceptions that mention 'PyInit_ycm_core' or 'initycm_core' |youcompleteme-i-get-importerror-exceptions-that-mention-pyinit_ycm_core-or-initycm_core| @@ -279,16 +281,16 @@ Vim. It has several completion engines: - a clangd [8]-based **experimental** completion engine for the C-family languages. - a Jedi [9]-based completion engine for Python 2 and 3, -- an OmniSharp [10]-based completion engine for C#, -- a combination of Gocode [11] and Godef [12] semantic engines for Go, -- a TSServer [13]-based completion engine for JavaScript and TypeScript, -- a racer [14]-based completion engine for Rust, -- a jdt.ls [15]-based experimental completion engine for Java. +- an OmniSharp-Roslyn [10]-based completion engine for C#, +- a Gopls [11]-based completion engine for Go, +- a TSServer [12]-based completion engine for JavaScript and TypeScript, +- a rls [13]-based completion engine for Rust, +- a jdt.ls [14]-based experimental completion engine for Java. - and an omnifunc-based completer that uses data from Vim's omnicomplete system to provide semantic completions for many other languages (Ruby, PHP etc.). - Image: YouCompleteMe GIF demo (see reference [16]) + Image: YouCompleteMe GIF demo (see reference [15]) Here's an explanation of what happens in the short GIF demo above. @@ -307,7 +309,7 @@ typing to further filter out unwanted completions. 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 -input needs to be a _subsequence [17] match_ of a completion. This is a fancy +input needs to be a _subsequence [16] match_ of a completion. This is a fancy 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 subsequence of 'xaybgc', but not of 'xbyxaxxc'. After the filter, a complicated @@ -326,7 +328,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 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 the completer engine +Syntastic [17]) if you are editing a C-family file. As the completer engine compiles your file 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 "just happens" in the background. @@ -357,7 +359,7 @@ summary and the full list of completer subcommands to find out what's available for your favourite languages. 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 [18]. =============================================================================== *youcompleteme-installation* @@ -371,13 +373,13 @@ These instructions (using 'install.py') are the quickest way to install YouCompleteMe, however they may not work for everyone. If the following instructions don't work for you, check out the full installation guide. -MacVim [20] is required. YCM won't work with the pre-installed Vim from Apple -as its Python support is broken. If you don't already use MacVim [20], install -it with Homebrew [21]. Install CMake as well: +MacVim [19] is required. YCM won't work with the pre-installed Vim from Apple +as its Python support is broken. If you don't already use MacVim [19], install +it with Homebrew [20]. Install CMake as well: > brew install cmake macvim < -Install YouCompleteMe with Vundle [22]. +Install YouCompleteMe with Vundle [21]. **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 @@ -413,26 +415,28 @@ Compiling YCM **without** semantic support for C-family languages: < The following additional language support options are available: -- C# support: install Mono with Homebrew [21] or by downloading the Mono - macOS package [23] and add '--cs-completer' when calling 'install.py'. +- C# support: install Mono with Homebrew [20] or by downloading the Mono + macOS package [22] and add '--cs-completer' when calling 'install.py'. -- Go support: install Go [24] and add '--go-completer' when calling +- Go support: install Go [23] and add '--go-completer' when calling 'install.py'. -- JavaScript and TypeScript support: install Node.js and npm [25] and add +- JavaScript and TypeScript support: install Node.js and npm [24] and add '--ts-completer' when calling 'install.py'. -- Rust support: install Rust [26] and add '--rust-completer' when calling - 'install.py'. +- Rust support: add '--rust-completer' when calling 'install.py'. + +- If your Python interpreter is older than 2.7.9, you will also need rustup + [25] in your 'PATH'. -- Java support: install JDK8 (version 8 required) [27] and add +- Java support: install JDK8 (version 8 required) [26] and add '--java-completer' when calling 'install.py'. To simply compile with everything enabled, there's a '--all' flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding '--clangd-completer'. So, to install with all language features, ensure -'xbuild', 'go', 'tsserver', 'node', 'npm', 'rustc', and 'cargo' tools are -installed and in your 'PATH', then simply run: +'xbuild', 'go', 'tsserver', 'node' and 'npm' tools are installed and in your +'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe ./install.py --all @@ -458,9 +462,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 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 -source [28] (don't worry, it's easy). +source [27] (don't worry, it's easy). -Install YouCompleteMe with Vundle [22]. +Install YouCompleteMe with Vundle [21]. **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 @@ -505,26 +509,28 @@ Compiling YCM **without** semantic support for C-family languages: < The following additional language support options are available: -- C# support: install Mono [29] and add '--cs-completer' when calling +- C# support: install Mono [28] and add '--cs-completer' when calling 'install.py'. -- Go support: install Go [24] and add '--go-completer' when calling +- Go support: install Go [23] and add '--go-completer' when calling 'install.py'. -- JavaScript and TypeScript support: install Node.js and npm [25] and add +- JavaScript and TypeScript support: install Node.js and npm [24] and add '--ts-completer' when calling 'install.py'. -- Rust support: install Rust [26] and add '--rust-completer' when calling - 'install.py'. +- Rust support: add '--rust-completer' when calling 'install.py'. + +- If your Python interpreter is older than 2.7.9, you will also need rustup + [25] in your 'PATH'. -- Java support: install JDK8 (version 8 required) [27] and add +- Java support: install JDK8 (version 8 required) [26] and add '--java-completer' when calling 'install.py'. To simply compile with everything enabled, there's a '--all' flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding '--clangd-completer'. So, to install with all language features, ensure -'xbuild', 'go', 'tsserver', 'node', 'npm', 'rustc', and 'cargo' tools are -installed and in your 'PATH', then simply run: +'xbuild', 'go', 'tsserver', 'node', 'npm' and tools are installed and in your +'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe python3 install.py --all @@ -555,18 +561,18 @@ 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 64-bit. It will be important when choosing the Python installer. We recommend using a 64-bit client. Daily updated installers of 32-bit and 64-bit Vim with -Python 2 and Python 3 support [30] are available. +Python 2 and Python 3 support [29] are available. Add the line: > set encoding=utf-8 < -to your vimrc [31] if not already present. This option is required by YCM. Note +to your vimrc [30] if not already present. This option is required by YCM. Note 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' command. -Install YouCompleteMe with Vundle [22]. +Install YouCompleteMe with Vundle [21]. **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 @@ -574,7 +580,7 @@ will notify you to recompile it. You should then rerun the install process. 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 [31]. Be sure to pick the version corresponding to 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. Additionally, the version of Python you install must match up exactly with the version of @@ -586,9 +592,9 @@ Download and install the following software: Python 3.5. You'll need one or the other installed, matching the version number exactly. -- CMake [33]. Add CMake executable to the PATH environment variable. +- CMake [32]. Add CMake executable to the PATH environment variable. -- Visual Studio Build Tools 2017 [34]. During setup, select _Visual C++ build +- Visual Studio Build Tools 2017 [33]. During setup, select _Visual C++ build tools_ in _Workloads_. Compiling YCM **with** semantic support for C-family languages through @@ -617,25 +623,27 @@ Compiling YCM **without** semantic support for C-family languages: The following additional language support options are available: - 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 [34]. -- Go support: install Go [24] and add '--go-completer' when calling +- Go support: install Go [23] and add '--go-completer' when calling 'install.py'. -- JavaScript and TypeScript support: install Node.js and npm [25] and add +- JavaScript and TypeScript support: install Node.js and npm [24] and add '--ts-completer' when calling 'install.py'. -- Rust support: install Rust [26] and add '--rust-completer' when calling - 'install.py'. +- Rust support: add '--rust-completer' when calling 'install.py'. + +- If your Python interpreter is older than 2.7.9, you will also need rustup + [25] in your 'PATH'. -- Java support: install JDK8 (version 8 required) [27] and add +- Java support: install JDK8 (version 8 required) [26] and add '--java-completer' when calling 'install.py'. To simply compile with everything enabled, there's a '--all' flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding '--clangd-completer'. So, to install with all language features, ensure -'msbuild', 'go', 'tsserver', 'node', 'npm', and 'cargo' tools are installed and -in your 'PATH', then simply run: +'msbuild', 'go', 'tsserver', 'node' and 'npm' tools are installed and in your +'PATH', then simply run: > cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe python install.py --all @@ -671,7 +679,7 @@ For FreeBSD 11.x, the requirement is cmake: > pkg install cmake < -Install YouCompleteMe with Vundle [22]. +Install YouCompleteMe with Vundle [21]. **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 @@ -710,23 +718,25 @@ The following additional language support options are available: - C# support: install Mono and add '--cs-completer' when calling './install.py'. -- Go support: install Go [24] and add '--go-completer' when calling +- Go support: install Go [23] and add '--go-completer' when calling './install.py'. -- JavaScript and TypeScript support: install Node.js and npm [25] and add +- JavaScript and TypeScript support: install Node.js and npm [24] and add '--ts-completer' when calling 'install.py'. -- Rust support: install Rust [26] and add '--rust-completer' when calling - './install.py'. +- Rust support: add '--rust-completer' when calling './install.py'. -- Java support: install JDK8 (version 8 required) [27] and add +- If your Python interpreter is older than 2.7.9, you will also need rustup + [25] in your 'PATH'. + +- Java support: install JDK8 (version 8 required) [26] and add '--java-completer' when calling './install.py'. To simply compile with everything enabled, there's a '--all' flag. Note that this flag does **not** install **clangd**. You need to specify it manually by adding '--clangd-completer'. So, to install with all language features, ensure -'xbuild', 'go', 'tsserver', 'node', 'npm', 'rustc', and 'cargo' tools are -installed and in your 'PATH', then simply run: +'xbuild', 'go', 'tsserver', 'node', 'npm' and tools are installed and in your +'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe ./install.py --all @@ -771,7 +781,7 @@ will notify you to recompile it. You should then rerun the install process. higher. 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 [27] (don't worry, it's easy). 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. @@ -781,9 +791,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 architectures. We recommend using a 64-bit Vim. -2. **Install YCM** with Vundle [22] (or Pathogen [36], but Vundle is a +2. **Install YCM** with Vundle [21] (or Pathogen [35], but Vundle is a better idea). With Vundle, this would mean adding a "Plugin - 'Valloric/YouCompleteMe'" line to your vimrc [31]. + 'Valloric/YouCompleteMe'" line to your vimrc [30]. If you don't install YCM with Vundle, make sure you have run 'git submodule update --init --recursive' after checking out the YCM @@ -799,13 +809,13 @@ will notify you to recompile it. You should then rerun the install process. In addition to 'libclang', YCM also supports an **experimental** clangd [8]-based completer. You can download the latest version of clangd [8] - from llvm.org releases [37]. Follow Step 4 to learn how to tell YCM where + from llvm.org releases [36]. Follow Step 4 to learn how to tell YCM where to find clangd binary. Please note that YCM is designed to work with clangd [8] version 8.0.0 or higher. You can use the system libclang or clangd _only if you are sure it is version 8.0.0 or higher_, otherwise don't. Even if it is, we recommend - using the official binaries from llvm.org [37] if at all possible. Make + using the official binaries from llvm.org [36] if at all possible. Make sure you download the correct archive file for your OS. We **STRONGLY recommend AGAINST use** of the system libclang or clangd @@ -818,17 +828,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 makefiles. Linux users can install cmake with their package manager ('sudo apt-get install cmake' for Ubuntu) whereas other users can - download and install [33] cmake from its project site. macOS users can - also get it through Homebrew [21] with 'brew install cmake'. + download and install [32] cmake from its project site. macOS users can + also get it through Homebrew [20] with 'brew install cmake'. 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-dev python3-dev'. On macOS 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 [31]. Pick the version corresponding to your Vim architecture. You will also need Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by - installing Visual Studio Build Tools [34]. MSVC 14 (Visual Studio 2015) + installing Visual Studio Build Tools [33]. MSVC 14 (Visual Studio 2015) and 15 (2017) are officially supported. Here we'll assume you installed YCM with Vundle. That means that the @@ -871,7 +881,7 @@ will notify you to recompile it. You should then rerun the install process. in step 3 and that you extracted the archive file to folder '~/ycm_temp/llvm_root_dir' (with 'bin', 'lib', 'include' etc. folders right inside that folder). On Windows, you can extract the files from the - LLVM+Clang installer using 7-zip [38]. + LLVM+Clang installer using 7-zip [37]. **NOTE:** This _only_ works with a _downloaded_ LLVM binary package, not a custom-built LLVM! See docs below for 'EXTERNAL_LIBCLANG_PATH' when @@ -921,7 +931,7 @@ will notify you to recompile it. You should then rerun the install process. 5. _This step is optional._ - Build the regex [39] module for improved Unicode support and better + Build the regex [38] module for improved Unicode support and better performance with regular expressions. The procedure is similar to compiling the 'ycm_core' library: > @@ -935,35 +945,38 @@ will notify you to recompile it. You should then rerun the install process. 6. Set up support for additional languages, as desired: - - C# support: install Mono on non-Windows platforms [40]. Navigate to - 'YouCompleteMe/third_party/ycmd/third_party/OmniSharpServer' and run - - msbuild /property:Configuration=Release /property:Platform="Any CPU" - /property:TargetFrameworkVersion=v4.5 + - C# support: install Mono on non-Windows platforms [39]. Navigate to + 'YouCompleteMe/third_party/ycmd/third_party/omnisharp-roslyn'. + Download an Omnisharp-Roslyn release archive [40] and extract the + archive to + 'YouCompleteMe/third_party/ycmd/third_party/omnisharp-roslyn'. On Windows, be sure that the build utility 'msbuild' is in your PATH - [35]. + [34]. - - Go support: install Go [24] and add it to your path. Navigate to - 'YouCompleteMe/third_party/ycmd/third_party/go' and in **both** - 'src/github.com/mdempsky/gocode' and 'src/github.com/rogpeppe/godef' - run + - Go support: install Go [23] and add it to your path. Navigate to 'You + CompleteMe/third_party/ycmd/third_party/go/src/golang.org/x/tools/cmd + /gopls' and run - GOPATH=$(realpath ../../../..) go build + go build - On Windows, first set 'GOPATH' to the absolute path of - 'YouCompleteMe/third_party/ycmd/third_party/go' then run 'go build' in - the two directories above. - - - JavaScript and TypeScript support: install Node.js and npm [25], + - JavaScript and TypeScript support: install Node.js and npm [24], navigate to 'YouCompleteMe/third_party/ycmd' and run 'npm install -g --prefix third_party/tsserver typescript'. - - Rust support: install Rust [26]. Navigate to - 'YouCompleteMe/third_party/ycmd/third_party/racerd' and run 'cargo - build --release'. + - Rust support: install rustup [25]. Export 'RUSTUP_HOME' environment + variable and point it to an empty temporary directory. Run the + following commands: + + rustup toolchain install nightly rustup default nightly rustup + component add rls rust-analysis rust-src - - Java support: install JDK8 (version 8 required) [27]. Download a + Ensure that 'YouCompleteMe/third_party/ycmd/third_party/rls' directory + exists and is empty. Go into the temporary directory and then into + 'toolchains/'. Finally, move everything from that directory to + 'YouCompleteMe/third_party/ycmd/third_party/rls'. + + - Java support: install JDK8 (version 8 required) [26]. Download a binary release of eclipse.jdt.ls [41] and extract it to 'YouCompleteM e/third_party/ycmd/third_party/eclipse.jdt.ls/target/repository'. Note: this approach is not recommended for most users and is @@ -1011,10 +1024,11 @@ C♯ ~ - Semantic auto-completion - Real-time diagnostic display - Go to declaration/definition (|GoTo|, etc.) +- Go to implementation (|GoToImplementation|) - View documentation comments for identifiers (|GetDoc|) - Type information for identifiers (|GetType|) - Automatically fix certain errors (|FixIt|) -- Management of OmniSharp server instance +- Management of OmniSharp-Roslyn server instance ------------------------------------------------------------------------------- *youcompleteme-python* @@ -1031,8 +1045,13 @@ Python ~ Go ~ - Semantic auto-completion -- Go to definition (|GoTo|) -- Management of 'gocode' server instance +- Real-time diagnostic display +- Go to declaration/definition (|GoTo|, etc.) +- Go to type definition (|GoToType|) +- Automatically fix certain errors (|FixIt|) +- Type information for identifiers (|GetType|) +- Code formatting (|Format|) +- Management of 'gopls' server instance ------------------------------------------------------------------------------- *youcompleteme-javascript-typescript* @@ -1057,10 +1076,16 @@ JavaScript and TypeScript ~ Rust ~ - Semantic auto-completion -- Go to definition (|GoTo|, |GoToDefinition|, and |GoToDeclaration| are - identical) +- Real-time diagnostic display +- Go to declaration/definition (|GoTo|, etc.) +- Go to implementation (|GoToImplementation|) +- Reference finding (|GoToReferences|) - View documentation comments for identifiers (|GetDoc|) -- Management of 'racer' server instance +- Type information for identifiers (|GetType|) +- Renaming symbols ('RefactorRename ') +- Code formatting (|Format|) +- Execute custom server command ('ExecuteCommand ') +- Management of 'rls' server instance ------------------------------------------------------------------------------- *youcompleteme-java* @@ -1083,6 +1108,7 @@ feedback. - Code formatting (|Format|) - Organize imports (|OrganizeImports|) - Detection of java projects +- Execute custom server command ('ExecuteCommand ') - Management of 'jdt.ls' server instance =============================================================================== @@ -1239,9 +1265,6 @@ directory. *youcompleteme-option-2-provide-flags-manually* Option 2: Provide the flags manually ~ -_Note that this option doesn't work with **experimental** clangd [8]-based -completer. You can use a compile_flags.txt [47] file instead._ - If you don't have a compilation database, or aren't able to generate one, you have to tell YouCompleteMe how to compile your code some other way. @@ -1291,14 +1314,14 @@ That's it! This is actually enough for most projects, but for complex projects it is not uncommon to integrate directly with an existing build system using the full power of the Python language. -For a more elaborate example, see ycmd's own '.ycm_extra_conf.py' [48]. You +For a more elaborate example, see ycmd's own '.ycm_extra_conf.py' [47]. You 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 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 projects. -You could also consider using YCM-Generator [49] to generate the +You could also consider using YCM-Generator [48] to generate the 'ycm_extra_conf.py' file. ------------------------------------------------------------------------------- @@ -1356,7 +1379,7 @@ of the two completer engines: Note that for clangd to have some of the above mentioned functionality, you need to provide a static index. For details on how to do that please have a -look at clangd-indexing [50]. +look at clangd-indexing [49]. To enable: @@ -1398,8 +1421,8 @@ Java Project Files ~ In order to provide semantic analysis, the Java completion engine requires knowledge of your project structure. In particular it needs to know the class -path to use, when compiling your code. Fortunately jdt.ls [15] supports eclipse -project files [51], maven projects [52] and gradle projects [53]. +path to use, when compiling your code. Fortunately jdt.ls [14] supports eclipse +project files [50], maven projects [51] and gradle projects [52]. **NOTE:** Our recommendation is to use either maven or gradle projects. @@ -1434,16 +1457,16 @@ native Java support. This can be done temporarily with ':EclimDisable'. *youcompleteme-eclipse-projects* Eclipse Projects ~ -Eclipse style projects require two files: .project [51] and .classpath [54]. +Eclipse style projects require two files: .project [50] and .classpath [53]. If your project already has these files due to previously being set up within -eclipse, then no setup is required. jdt.ls [15] should load the project just +eclipse, then no setup is required. jdt.ls [14] should load the project just fine (it's basically eclipse after all). However, if not, it is possible (easy in fact) to craft them manually, though it is not recommended. You're better off using gradle or maven (see below). -A simple eclipse style project example [55] can be found in the ycmd test +A simple eclipse style project example [54] can be found in the ycmd test directory. Normally all that is required is to copy these files to the root of your project and to edit the '.classpath' to add additional libraries, such as: > @@ -1463,10 +1486,10 @@ don't already use eclipse to manage your projects. *youcompleteme-maven-projects* Maven Projects ~ -Maven needs a file named pom.xml [52] in the root of the project. Once again a -simple pom.xml [56] can be found in ycmd source. +Maven needs a file named pom.xml [51] in the root of the project. Once again a +simple pom.xml [55] can be found in ycmd source. -The format of pom.xml [52] files is way beyond the scope of this document, but +The format of pom.xml [51] files is way beyond the scope of this document, but we do recommend using the various tools that can generate them for you, if you're not familiar with them already. @@ -1474,10 +1497,10 @@ you're not familiar with them already. *youcompleteme-gradle-projects* Gradle Projects ~ -Gradle projects require a build.gradle [53]. Again, there is a trivial example -in ycmd's tests [57]. +Gradle projects require a build.gradle [52]. Again, there is a trivial example +in ycmd's tests [56]. -The format of build.gradle [53] files is way beyond the scope of this document, +The format of build.gradle [52] files is way beyond the scope of this document, but we do recommend using the various tools that can generate them for you, if you're not familiar with them already. @@ -1506,7 +1529,7 @@ configured the project files, in particular check that the classpath is set correctly. For anything else, contact us. Java support is experimental at present so we'd -love to hear your feedback! Please do remember to check CONTRIBUTING.md [58] +love to hear your feedback! Please do remember to check CONTRIBUTING.md [57] for the list of diagnostics we'll need. ------------------------------------------------------------------------------- @@ -1581,7 +1604,7 @@ the second position of 'sys.path': sys_path.insert( 1, '/path/to/third_party/package' ) return sys_path < -A more advanced example can be found in YCM's own '.ycm_extra_conf.py' [59]. +A more advanced example can be found in YCM's own '.ycm_extra_conf.py' [58]. ------------------------------------------------------------------------------- *youcompleteme-configuring-through-vim-options* @@ -1625,40 +1648,31 @@ Rust Semantic Completion ~ Completions and GoTo commands within the current crate and its dependencies should work out of the box with no additional configuration (provided that you built YCM with the '--rust-completer' flag; see the _Installation_ section for -details). For semantic analysis inclusive of the standard library, you must -have a local copy of the Rust source code [60]. If using rustup [61], run the -following command to download the code: -> - rustup component add rust-src -< -YCM will find its location automatically. Otherwise, download the archive, -extract it somewhere, and set the following option so YCM can locate it: -> - " In this example, the Rust source code archive has been extracted to - " /usr/local/rust/rustc-1.20.0 - let g:ycm_rust_src_path = '/usr/local/rust/rustc-1.20.0/src' -< +details). The install script takes care of installing the Rust source code +[59], so no configuration is necessary. In case you are running Python 2.7.8 +and older, you will need to manually install rustup [25]. + ------------------------------------------------------------------------------- *youcompleteme-javascript-typescript-semantic-completion* JavaScript and TypeScript Semantic Completion ~ -**NOTE:** YCM originally used the Tern [62] engine for JavaScript but due to -Tern [62] not being maintained anymore by its main author and the TSServer [13] -engine offering more features, YCM is moving to TSServer [13]. This won't -affect you if you were already using Tern [62] but you are encouraged to do the +**NOTE:** YCM originally used the Tern [60] engine for JavaScript but due to +Tern [60] not being maintained anymore by its main author and the TSServer [12] +engine offering more features, YCM is moving to TSServer [12]. This won't +affect you if you were already using Tern [60] but you are encouraged to do the switch by deleting the 'third_party/ycmd/third_party/tern_runtime/node_modules' -directory in YCM folder. If you are a new user but still want to use Tern [62], +directory in YCM folder. If you are a new user but still want to use Tern [60], you should pass the '--js-completer' option to the 'install.py' script during -installation. Further instructions on how to setup YCM with Tern [62] are -available on the wiki [63]. +installation. Further instructions on how to setup YCM with Tern [60] are +available on the wiki [61]. -All JavaScript and TypeScript features are provided by the TSServer [13] +All JavaScript and TypeScript features are provided by the TSServer [12] engine, which is included in the TypeScript SDK. To enable these features, -install Node.js and npm [25] and call the 'install.py' script with the +install Node.js and npm [24] and call the 'install.py' script with the '--ts-completer' flag. -TSServer [13] relies on the 'jsconfig.json' file [64] for JavaScript and the -'tsconfig.json' file [65] for TypeScript to analyze your project. Ensure the +TSServer [12] relies on the 'jsconfig.json' file [62] for JavaScript and the +'tsconfig.json' file [63] for TypeScript to analyze your project. Ensure the file exists at the root of your project. To get diagnostics in JavaScript, set the 'checkJs' option to 'true' in your @@ -1675,8 +1689,8 @@ To get diagnostics in JavaScript, set the 'checkJs' option to 'true' in your Semantic Completion for Other Languages ~ C-family, C#, Go, Java, Python, Rust, and JavaScript/TypeScript languages are -supported natively by YouCompleteMe using the Clang [7], OmniSharp [10], Gocode -[11]/Godef [12], jdt.ls [15], Jedi [9], racer [14], and TSServer [13] engines, +supported natively by YouCompleteMe using the Clang [7], OmniSharp-Roslyn [10], +Gopls [11], jdt.ls [14], Jedi [9], rls [13], and TSServer [12] engines, respectively. Check the installation section for instructions to enable these features if desired. @@ -1685,7 +1699,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 languages like Ruby, PHP, etc. It depends on the language. -You can get a stellar omnifunc for Ruby with Eclim [66]. Just make sure you +You can get a stellar omnifunc for Ruby with Eclim [64]. Just make sure you have the _latest_ Eclim installed and configured (this means Eclim '>= 2.2.*' and Eclipse '>= 4.2.*'). @@ -1702,7 +1716,7 @@ Writing New Semantic Completers ~ 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 -YCM using the Completer API [67]. +YCM using the Completer API [65]. Here are the differences between the two approaches: @@ -1721,7 +1735,7 @@ Here are the differences between the two approaches: than VimScript. 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 [67]. +complete-functions'. For the Completer API, see the API docs [65]. If you want to upstream your completer into YCM's source, you should use the Completer API. @@ -1730,10 +1744,10 @@ Completer API. *youcompleteme-diagnostic-display* Diagnostic Display ~ -YCM will display diagnostic notifications for the C-family, C#, Java, -JavaScript, and TypeScript languages. Since YCM continuously recompiles your -file as you type, you'll get notified of errors and warnings in your file as -fast as possible. +YCM will display diagnostic notifications for the C-family, C#, Go, Java, +JavaScript, Rust and TypeScript languages. Since YCM continuously recompiles +your file as you type, you'll get notified of errors and warnings in your file +as fast as possible. Here are the various pieces of the diagnostic UI: @@ -1772,7 +1786,7 @@ current file in Vim's 'locationlist', which can be opened with the ':lopen' and ':lclose' commands (make sure you have set 'let 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 -another (very small) Vim plugin called ListToggle [68] (which also makes it +another (very small) Vim plugin called ListToggle [66] (which also makes it possible to change the height of the 'locationlist' window), also written by yours truly. @@ -1984,7 +1998,7 @@ This command attempts to find all of the references within the project to the identifier under the cursor and populates the quickfix list with those locations. -Supported in filetypes: 'java, javascript, python, typescript' +Supported in filetypes: 'java, javascript, python, typescript, rust' ------------------------------------------------------------------------------- The *GoToImplementation* subcommand @@ -1993,7 +2007,7 @@ Looks up the symbol under the cursor and jumps to its implementation (i.e. non-interface). If there are multiple implementations, instead provides a list of implementations to choose from. -Supported in filetypes: 'cs, java' +Supported in filetypes: 'cs, java, rust' ------------------------------------------------------------------------------- The *GoToImplementationElseDeclaration* subcommand @@ -2010,7 +2024,7 @@ The *GoToType* subcommand Looks up the symbol under the cursor and jumps to the definition of its type e.g. if the symbol is an object, go to the definition of its class. -Supported in filetypes: 'java, javascript, typescript' +Supported in filetypes: 'go, java, javascript, typescript' ------------------------------------------------------------------------------- *youcompleteme-semantic-information-commands* @@ -2033,8 +2047,8 @@ Invoking this command on 's' returns 'std::string => std::basic_string' **NOTE:** Causes re-parsing of the current translation unit. -Supported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, python, -typescript' +Supported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, go, +python, typescript, rust' ------------------------------------------------------------------------------- The *GetTypeImprecise* subcommand @@ -2144,7 +2158,7 @@ indication). **NOTE:** Causes re-parsing of the current translation unit. -Supported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, java, javascript, +Supported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript, typescript' ------------------------------------------------------------------------------- @@ -2161,7 +2175,7 @@ files. Rename operations may involve changes to multiple files, which may or may not be open in Vim buffers at the time. YouCompleteMe handles all of this for you. The behavior is described in the following section. -Supported in filetypes: 'java, javascript, typescript' +Supported in filetypes: 'java, javascript, typescript, rust' ------------------------------------------------------------------------------- *youcompleteme-multi-file-refactor* @@ -2205,7 +2219,7 @@ select it in one of Vim's visual modes (see ':h visual-use') and run the command or directly enter the range on the command line, e.g. ':2,5YcmCompleter Format' to format it from line 2 to line 5. -Supported in filetypes: 'java, javascript, typescript' +Supported in filetypes: 'java, javascript, go, typescript, rust' ------------------------------------------------------------------------------- The *OrganizeImports* subcommand @@ -2224,6 +2238,18 @@ These commands are for general administration, rather than IDE-like features. They cover things like the semantic engine server instance and compilation flags. +------------------------------------------------------------------------------- + *ExecuteCommand-args* +The 'ExecuteCommand ' subcommand ~ + +Some LSP completers (currently Rust and Java completers) support executing +server specific commands. Consult the rls [13] and jdt.ls [14] respective +documentations to find out what commands are supported and which arguments are +expected. + +The support for 'ExecuteCommand' was implemented to support plugins like +vimspector [67] to debug java, but isn't limited to that specific use case. + ------------------------------------------------------------------------------- The *RestartServer* subcommand @@ -2244,14 +2270,15 @@ the server with the |:YcmRestartServer| command). This command clears that cache entirely. YCM will then re-query your 'Settings' function or your compilation database as needed in the future. -Supported in filetypes: 'c, cpp, objc, objcpp, cuda' +Supported in filetypes: 'c, cpp, objc, objcpp, cuda, rust' ------------------------------------------------------------------------------- The *ReloadSolution* subcommand -Instruct the Omnisharp server to clear its cache and reload all files from -disk. This is useful when files are added, removed, or renamed in the solution, -files are changed outside of Vim, or whenever Omnisharp cache is out-of-sync. +Instruct the Omnisharp-Roslyn server to clear its cache and reload all files +from disk. This is useful when files are added, removed, or renamed in the +solution, files are changed outside of Vim, or whenever Omnisharp-Roslyn cache +is out-of-sync. Supported in filetypes: 'cs' @@ -2270,7 +2297,7 @@ For example: call youcompleteme#GetErrorCount() < Both this function and |youcompleteme#GetWarningCount| can be useful when -integrating YCM with other Vim plugins. For example, a lightline [69] user +integrating YCM with other Vim plugins. For example, a lightline [68] user could add a diagnostics section to their statusline which would display the number of errors and warnings. @@ -2334,11 +2361,11 @@ Options ~ 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 -vimrc script [31] by including a line like this: +vimrc script [30] by including a line like this: > let g:ycm_min_num_of_chars_for_completion = 1 < -Note that after changing an option in your vimrc script [31] you have to +Note that after changing an option in your vimrc script [30] you have to restart ycmd [43] with the |:YcmRestartServer| command for the changes to take effect. @@ -2638,13 +2665,13 @@ YCM will not render it. The following filter types are supported: -- "regex": Accepts a string regular expression [70]. This type matches when +- "regex": Accepts a string regular expression [69]. This type matches when the regex (treated as case-insensitive) is found in the diagnostic text. - "level": Accepts a string level, either "warning" or "error." This type matches when the diagnostic has the same level. -**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [70]. +**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [69]. Default: '{}' > @@ -2733,7 +2760,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. -The only supported tag format is the Exuberant Ctags format [71]. The format +The only supported tag format is the Exuberant Ctags format [70]. The format 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 'language:' field in the tags output. @@ -2836,8 +2863,8 @@ Default: 'info' ------------------------------------------------------------------------------- The *g:ycm_auto_start_csharp_server* option -When set to '1', the OmniSharp server will be automatically started (once per -Vim session) when you open a C# file. +When set to '1', the OmniSharp-Roslyn server will be automatically started +(once per Vim session) when you open a C# file. Default: '1' > @@ -2846,7 +2873,7 @@ Default: '1' ------------------------------------------------------------------------------- The *g:ycm_auto_stop_csharp_server* option -When set to '1', the OmniSharp server will be automatically stopped upon +When set to '1', the OmniSharp-Roslyn server will be automatically stopped upon closing Vim. Default: '1' @@ -2857,8 +2884,8 @@ Default: '1' The *g:ycm_csharp_server_port* option When g:ycm_auto_start_csharp_server is set to '1', specifies the port for the -OmniSharp server to listen on. When set to '0' uses an unused port provided by -the OS. +OmniSharp-Roslyn server to listen on. When set to '0' uses an unused port +provided by the OS. Default: '0' > @@ -2973,7 +3000,7 @@ The *g:ycm_key_list_stop_completion* option This option controls the key mappings used to close the completion menu. This is useful when the menu is blocking the view, when you need to insert the -'' character, or when you want to expand a snippet from UltiSnips [19] and +'' character, or when you want to expand a snippet from UltiSnips [18] and navigate through it. Default: "['']" @@ -3115,7 +3142,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, 're!\w+\.' would only trigger after the '\w+\.' regex matches. -**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [70]. +**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [69]. Default: '[see next line]' > @@ -3248,6 +3275,15 @@ Default: '1' > let g:ycm_clangd_uses_ycmd_caching = 1 < +------------------------------------------------------------------------------- +The *g:ycm_java_jdtls_extension_path* option + +This option declares a list of paths where a jdt.ls extension can be found. + +Default: '[]' +> + let g:ycm_java_jdtls_extension_path = [] +< =============================================================================== *youcompleteme-faq* FAQ ~ @@ -3439,7 +3475,7 @@ I see 'undefined symbol: clang_getCompletionFixIt' in the server logs. ~ This means that the server is trying to load a version of libclang that is too old. You need at least libclang 8.0.0. We recommend running the 'install.py' script without '--system-libclang' or downloading the latest prebuilt binaries -from llvm.org [37] when going through the full installation guide. +from llvm.org [36] when going through the full installation guide. ------------------------------------------------------------------------------- *youcompleteme-i-get-fatal-python-error-pythreadstate_get-no-current-thread-on-startup* @@ -3472,15 +3508,15 @@ YCM does not read identifiers from my tags files ~ First, put 'let g:ycm_collect_identifiers_from_tags_files = 1' in your vimrc. -Make sure you are using Exuberant Ctags [72] to produce your tags files since -the only supported tag format is the Exuberant Ctags format [71]. The format +Make sure you are using Exuberant Ctags [71] to produce your tags files since +the only supported tag format is the Exuberant Ctags format [70]. The format from "plain" ctags is NOT supported. The output of 'ctags --version' should -list "Exuberant Ctags". See Universal Ctags [73] for a maintained version. +list "Exuberant Ctags". See Universal Ctags [72] for a maintained version. Ctags needs to be called with the '--fields=+l' (that's a lowercase 'L', not a one) option because YCM needs the 'language:' field in the tags output. -**NOTE:** Exuberant Ctags [72] by default sets language tag for '*.h' files as +**NOTE:** Exuberant Ctags [71] by default sets language tag for '*.h' files as 'C++'. If you have C (not C++) project, consider giving parameter '--langmap=c:.c.h' to ctags to see tags from '*.h' files. @@ -3559,7 +3595,7 @@ asynchronicity. This feature is available since Vim 7.4.1578. *youcompleteme-nasty-bugs-happen-if-i-have-vim-autoclose-plugin-installed* Nasty bugs happen if I have the 'vim-autoclose' plugin installed ~ -Use the delimitMate [74] plugin instead. It does the same thing without +Use the delimitMate [73] plugin instead. It does the same thing without conflicting with YCM. ------------------------------------------------------------------------------- @@ -3567,7 +3603,7 @@ conflicting with YCM. 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 -[75] mailing list, _don't_ create issues on the tracker. The tracker is for bug +[74] mailing list, _don't_ create issues on the tracker. The tracker is for bug reports and feature requests. ------------------------------------------------------------------------------- @@ -3621,7 +3657,7 @@ mismatch in assumptions causes performance problems since Syntastic code isn't optimized for this use case of constant diagnostic refreshing. Poor support for this use case also led to crash bugs in Vim caused by -Syntastic-Vim interactions (issue #593 [76]) and other problems, like random +Syntastic-Vim interactions (issue #593 [75]) and other problems, like random Vim flickering. Attempts were made to resolve these issues in Syntastic, but ultimately some of them failed (for various reasons). @@ -3657,7 +3693,7 @@ paths, prepend '-isystem' to each individual path and append them all to the list of flags you return from your 'Settings' function in your '.ycm_extra_conf.py' file. -See issue #303 [77] for details. +See issue #303 [76] for details. ------------------------------------------------------------------------------- *youcompleteme-when-i-start-vim-i-get-runtime-error-saying-r6034-an-application-has-made-an-attempt-to-load-c-runtime-library-incorrectly.* @@ -3665,7 +3701,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.' ~ CMake and other things seem to screw up the PATH with their own msvcrXX.dll -versions. [78] Add the following to the very top of your vimrc to remove these +versions. [77] Add the following to the very top of your vimrc to remove these entries from the path. > python << EOF @@ -3701,7 +3737,7 @@ On Windows I get "E887: Sorry, this command is disabled, the Python's site ~ module could not be loaded" ~ If you are running vim on Windows with Python 2.7.11, this is likely caused by -a bug [79]. Follow this workaround [80] or use a different version (Python +a bug [78]. Follow this workaround [79] or use a different version (Python 2.7.12 does not suffer from the bug). ------------------------------------------------------------------------------- @@ -3787,17 +3823,17 @@ using this key to cycle through YCM's suggestions without changing the value of Contributor Code of Conduct ~ Please note that this project is released with a Contributor Code of Conduct -[81]. By participating in this project you agree to abide by its terms. +[80]. By participating in this project you agree to abide by its terms. =============================================================================== *youcompleteme-contact* Contact ~ If you have questions about the plugin or need help, please join the Gitter -room [1] or use the ycm-users [75] mailing list. +room [1] or use the ycm-users [74] mailing list. If you have bug reports or feature suggestions, please use the issue tracker -[82]. Before you do, please carefully read CONTRIBUTING.md [58] as this asks +[81]. Before you do, please carefully read CONTRIBUTING.md [57] as this asks for important diagnostics which the team will use to help get you going. The latest version of the plugin is available at @@ -3812,7 +3848,7 @@ YouCompleteMe maintainers directly using the contact details. *youcompleteme-license* License ~ -This software is licensed under the GPL v3 license [83]. © 2015-2018 +This software is licensed under the GPL v3 license [82]. © 2015-2018 YouCompleteMe contributors =============================================================================== @@ -3823,84 +3859,83 @@ References ~ [2] https://img.shields.io/gitter/room/Valloric/YouCompleteMe.svg [3] https://dev.azure.com/YouCompleteMe/YCM/_build/latest?definitionId=1&branchName=master [4] https://dev.azure.com/YouCompleteMe/YCM/_apis/build/status/Valloric.YouCompleteMe?branchName=master -[5] https://codecov.io/gh/Valloric/YouCompleteMe -[6] https://img.shields.io/codecov/c/github/Valloric/YouCompleteMe/master.svg +[5] https://codecov.io/gh/ycm-core/YouCompleteMe +[6] https://img.shields.io/codecov/c/github/ycm-core/YouCompleteMe/master.svg [7] http://clang.llvm.org/ [8] https://clang.llvm.org/extra/clangd.html [9] https://github.com/davidhalter/jedi -[10] https://github.com/OmniSharp/omnisharp-server -[11] https://github.com/nsf/gocode -[12] https://github.com/Manishearth/godef -[13] https://github.com/Microsoft/TypeScript/tree/master/src/server -[14] https://github.com/phildawes/racer -[15] https://github.com/eclipse/eclipse.jdt.ls -[16] http://i.imgur.com/0OP4ood.gif -[17] https://en.wikipedia.org/wiki/Subsequence -[18] https://github.com/scrooloose/syntastic -[19] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt -[20] https://macvim-dev.github.io/macvim/ -[21] http://brew.sh -[22] https://github.com/VundleVim/Vundle.vim#about -[23] http://www.mono-project.com/docs/getting-started/install/mac/ -[24] https://golang.org/doc/install -[25] https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm -[26] https://www.rust-lang.org/ -[27] http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html -[28] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source -[29] https://www.mono-project.com/download/stable/#download-lin -[30] https://github.com/vim/vim-win32-installer/releases -[31] http://vimhelp.appspot.com/starting.txt.html#vimrc -[32] https://www.python.org/downloads/windows/ -[33] https://cmake.org/download/ -[34] https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=15 -[35] http://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1 -[36] https://github.com/tpope/vim-pathogen#pathogenvim -[37] http://llvm.org/releases/download.html -[38] http://www.7-zip.org/download.html -[39] https://pypi.org/project/regex/ -[40] http://www.mono-project.com/docs/getting-started/install/ +[10] https://github.com/OmniSharp/omnisharp-roslyn +[11] https://github.com/golang/go/wiki/gopls +[12] https://github.com/Microsoft/TypeScript/tree/master/src/server +[13] https://github.com/rust-lang/rls +[14] https://github.com/eclipse/eclipse.jdt.ls +[15] http://i.imgur.com/0OP4ood.gif +[16] https://en.wikipedia.org/wiki/Subsequence +[17] https://github.com/scrooloose/syntastic +[18] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt +[19] https://macvim-dev.github.io/macvim/ +[20] http://brew.sh +[21] https://github.com/VundleVim/Vundle.vim#about +[22] http://www.mono-project.com/docs/getting-started/install/mac/ +[23] https://golang.org/doc/install +[24] https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm +[25] https://www.rustup.rs/ +[26] http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html +[27] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source +[28] https://www.mono-project.com/download/stable/#download-lin +[29] https://github.com/vim/vim-win32-installer/releases +[30] http://vimhelp.appspot.com/starting.txt.html#vimrc +[31] https://www.python.org/downloads/windows/ +[32] https://cmake.org/download/ +[33] https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=15 +[34] http://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1 +[35] https://github.com/tpope/vim-pathogen#pathogenvim +[36] http://llvm.org/releases/download.html +[37] http://www.7-zip.org/download.html +[38] https://pypi.org/project/regex/ +[39] http://www.mono-project.com/docs/getting-started/install/ +[40] https://github.com/OmniSharp/omnisharp-roslyn/releases [41] http://download.eclipse.org/jdtls/milestones [42] https://www.unicode.org/glossary/#diacritic [43] https://github.com/Valloric/ycmd [44] http://clang.llvm.org/docs/JSONCompilationDatabase.html [45] https://ninja-build.org/manual.html [46] https://github.com/rizsotto/Bear -[47] https://clang.llvm.org/docs/JSONCompilationDatabase.html#alternatives -[48] https://raw.githubusercontent.com/Valloric/ycmd/66030cd94299114ae316796f3cad181cac8a007c/.ycm_extra_conf.py -[49] https://github.com/rdnetto/YCM-Generator -[50] https://clang.llvm.org/extra/clangd.html#project-wide-indexing -[51] https://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fproject_description_file.html -[52] https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html -[53] https://docs.gradle.org/current/userguide/tutorial_java_projects.html -[54] https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2FIClasspathEntry.html -[55] https://github.com/Valloric/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_eclipse_project -[56] https://github.com/Valloric/ycmd/blob/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_maven_project/pom.xml -[57] https://github.com/Valloric/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_gradle_project -[58] https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md -[59] https://github.com/Valloric/YouCompleteMe/blob/master/.ycm_extra_conf.py -[60] https://www.rust-lang.org/downloads.html -[61] https://www.rustup.rs/ -[62] http://ternjs.net -[63] https://github.com/Valloric/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern -[64] https://code.visualstudio.com/docs/languages/jsconfig -[65] https://www.typescriptlang.org/docs/handbook/tsconfig-json.html -[66] http://eclim.org/ -[67] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py -[68] https://github.com/Valloric/ListToggle -[69] https://github.com/itchyny/lightline.vim -[70] https://docs.python.org/2/library/re.html#regular-expression-syntax -[71] http://ctags.sourceforge.net/FORMAT -[72] http://ctags.sourceforge.net/ -[73] https://github.com/universal-ctags/ctags -[74] https://github.com/Raimondi/delimitMate -[75] https://groups.google.com/forum/?hl=en#!forum/ycm-users -[76] https://github.com/Valloric/YouCompleteMe/issues/593 -[77] https://github.com/Valloric/YouCompleteMe/issues/303 -[78] http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022 -[79] https://github.com/vim/vim/issues/717 -[80] https://github.com/vim/vim-win32-installer/blob/a27bbdba9bb87fa0e44c8a00d33d46be936822dd/appveyor.bat#L86-L88 -[81] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md -[82] https://github.com/Valloric/YouCompleteMe/issues?state=open -[83] http://www.gnu.org/copyleft/gpl.html +[47] https://raw.githubusercontent.com/Valloric/ycmd/66030cd94299114ae316796f3cad181cac8a007c/.ycm_extra_conf.py +[48] https://github.com/rdnetto/YCM-Generator +[49] https://clang.llvm.org/extra/clangd.html#project-wide-indexing +[50] https://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fproject_description_file.html +[51] https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html +[52] https://docs.gradle.org/current/userguide/tutorial_java_projects.html +[53] https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2FIClasspathEntry.html +[54] https://github.com/Valloric/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_eclipse_project +[55] https://github.com/Valloric/ycmd/blob/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_maven_project/pom.xml +[56] https://github.com/Valloric/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_gradle_project +[57] https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md +[58] https://github.com/Valloric/YouCompleteMe/blob/master/.ycm_extra_conf.py +[59] https://www.rust-lang.org/downloads.html +[60] http://ternjs.net +[61] https://github.com/Valloric/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern +[62] https://code.visualstudio.com/docs/languages/jsconfig +[63] https://www.typescriptlang.org/docs/handbook/tsconfig-json.html +[64] http://eclim.org/ +[65] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py +[66] https://github.com/Valloric/ListToggle +[67] https://github.com/puremourning/vimspector +[68] https://github.com/itchyny/lightline.vim +[69] https://docs.python.org/2/library/re.html#regular-expression-syntax +[70] http://ctags.sourceforge.net/FORMAT +[71] http://ctags.sourceforge.net/ +[72] https://github.com/universal-ctags/ctags +[73] https://github.com/Raimondi/delimitMate +[74] https://groups.google.com/forum/?hl=en#!forum/ycm-users +[75] https://github.com/Valloric/YouCompleteMe/issues/593 +[76] https://github.com/Valloric/YouCompleteMe/issues/303 +[77] http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022 +[78] https://github.com/vim/vim/issues/717 +[79] https://github.com/vim/vim-win32-installer/blob/a27bbdba9bb87fa0e44c8a00d33d46be936822dd/appveyor.bat#L86-L88 +[80] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md +[81] https://github.com/Valloric/YouCompleteMe/issues?state=open +[82] http://www.gnu.org/copyleft/gpl.html vim: ft=help diff --git a/plugin/youcompleteme.vim b/plugin/youcompleteme.vim index 38426df78e..c9d18e3e17 100644 --- a/plugin/youcompleteme.vim +++ b/plugin/youcompleteme.vim @@ -257,22 +257,6 @@ let g:ycm_use_ultisnips_completer = let g:ycm_csharp_server_port = \ get( g:, 'ycm_csharp_server_port', 0 ) -" These options are not documented. -let g:ycm_gocode_binary_path = - \ get( g:, 'ycm_gocode_binary_path', '' ) - -let g:ycm_godef_binary_path = - \ get( g:, 'ycm_godef_binary_path', '' ) - -let g:ycm_rust_src_path = - \ get( g:, 'ycm_rust_src_path', '' ) - -let g:ycm_racerd_binary_path = - \ get( g:, 'ycm_racerd_binary_path', '' ) - -let g:ycm_java_jdtls_use_clean_workspace = - \ get( g:, 'ycm_java_jdtls_use_clean_workspace', 1 ) - let g:ycm_use_clangd = \ get( g:, 'ycm_use_clangd', 1 ) @@ -285,6 +269,16 @@ let g:ycm_clangd_args = let g:ycm_clangd_uses_ycmd_caching = \ get( g:, 'ycm_clangd_uses_ycmd_caching', 1 ) +let g:ycm_java_jdtls_extension_path = + \ get( g:, 'ycm_java_jdtls_extension_path', [] ) + +" These options are not documented. +let g:ycm_java_jdtls_use_clean_workspace = + \ get( g:, 'ycm_java_jdtls_use_clean_workspace', 1 ) + +let g:ycm_java_jdtls_workspace_root_path = + \ get( g:, 'ycm_java_jdtls_workspace_root_path', '' ) + " This option is deprecated. let g:ycm_python_binary_path = \ get( g:, 'ycm_python_binary_path', '' ) diff --git a/third_party/ycmd b/third_party/ycmd index 1827ebee82..14a616c846 160000 --- a/third_party/ycmd +++ b/third_party/ycmd @@ -1 +1 @@ -Subproject commit 1827ebee82fd41dac408ffe4c7b1e867ac72ee7c +Subproject commit 14a616c846f13a9ccb3003b04f390bd6071c7a95