plugged.zip

YouCompleteMe: a code-completion engine for Vim =============================================== [](https://gitter.im/Valloric/YouCompleteMe) [](https://dev.azure.com/YouCompleteMe/YCM/_build?definitionId=3&branchName=master) [](https://codecov.io/gh/ycm-core/YouCompleteMe) Help, Advice, Support --------------------- Looking for help, advice or support? Having problems getting YCM to work? First carefully read the [installation instructions](#installation) for your OS. We recommend you use the supplied `install.py`. Next check the [User Guide](#user-guide) section on the semantic completer that you are using. For C/C++/Objective-C/Objective-C++/CUDA, you _must_ read [this section](#c-family-semantic-completion). Finally, check the [FAQ](#faq). If, after reading the installation and user guides, and checking the FAQ, you're still having trouble, check the [contacts](#contact) section below for how to get in touch. Please do **NOT** go to #vim on freenode for support. Please contact the YouCompleteMe maintainers directly using the [contact details](#contact) below. Contents -------- - [Intro](#intro) - [Installation](#installation) - [macOS](#macos) - [Linux 64-bit](#linux-64-bit) - [Windows](#windows) - [FreeBSD/OpenBSD](#freebsdopenbsd) - [Full Installation Guide](#full-installation-guide) - [Quick Feature Summary](#quick-feature-summary) - [User Guide](#user-guide) - [General Usage](#general-usage) - [Client-Server Architecture](#client-server-architecture) - [Completion String Ranking](#completion-string-ranking) - [General Semantic Completion](#general-semantic-completion) - [C-family Semantic Completion](#c-family-semantic-completion) - [Java Semantic Completion](#java-semantic-completion) - [Python Semantic Completion](#python-semantic-completion) - [Rust Semantic Completion](#rust-semantic-completion) - [Go Semantic Completion](#go-semantic-completion) - [JavaScript and TypeScript Semantic Completion](#javascript-and-typescript-semantic-completion) - [Semantic Completion for Other Languages](#semantic-completion-for-other-languages) - [LSP Configuration](#lsp-configuration) - [Writing New Semantic Completers](#writing-new-semantic-completers) - [Diagnostic Display](#diagnostic-display) - [Diagnostic Highlighting Groups](#diagnostic-highlighting-groups) - [Commands](#commands) - [YcmCompleter subcommands](#ycmcompleter-subcommands) - [GoTo Commands](#goto-commands) - [Semantic Information Commands](#semantic-information-commands) - [Refactoring Commands](#refactoring-commands) - [Miscellaneous Commands](#miscellaneous-commands) - [Functions](#functions) - [Autocommands](#autocommands) - [Options](#options) - [FAQ](#faq) - [Contributor Code of Conduct](#contributor-code-of-conduct) - [Contact](#contact) - [License](#license) Intro ----- YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for [Vim][]. It has several completion engines: - an identifier-based engine that works with every programming language, - a [Clang][]-based engine that provides native semantic code completion for C/C++/Objective-C/Objective-C++/CUDA (from now on referred to as "the C-family languages"), - a [clangd][]-based **experimental** completion engine for the C-family languages. - a [Jedi][]-based completion engine for Python 2 and 3, - 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 [rls][]-based completion engine for Rust, - a [jdt.ls][]-based experimental completion engine for Java. - a [generic Language Server Protocol implementation for any language](#plugging-an-arbitrary-lsp-server) - and an omnifunc-based completer that uses data from Vim's omnicomplete system to provide semantic completions for many other languages (Ruby, PHP etc.).  Here's an explanation of what happens in the short GIF demo above. First, realize that **no keyboard shortcuts had to be pressed** to get the list of completion candidates at any point in the demo. The user just types and the suggestions pop up by themselves. If the user doesn't find the completion suggestions relevant and/or just wants to type, they can do so; the completion engine will not interfere. When the user sees a useful completion string being offered, they press the TAB key to accept it. This inserts the completion string. Repeated presses of the TAB key cycle through the offered completions. If the offered completions are not relevant enough, the user can continue 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][] 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 sorting system ranks the completion strings so that the most relevant ones rise to the top of the menu (so you usually need to press TAB just once). **All of the above works with any programming language** because of the identifier-based completion engine. It collects all of the identifiers in the current file and other files you visit (and your tags files) and searches them when you type (identifiers are put into per-filetype groups). The demo also shows the semantic engine in use. When the user presses `.`, `->` or `::` while typing in insert mode (for C++; different triggers are used for other languages), the semantic engine is triggered (it can also be triggered 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][]) 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. In essence, YCM obsoletes the following Vim plugins because it has all of their features plus extra: - clang_complete - AutoComplPop - Supertab - neocomplcache **And that's not all...** YCM also provides [semantic IDE-like features](#quick-feature-summary) in a number of languages, including: - finding declarations, definitions, usages, etc. of identifiers, - displaying type information for classes, variables, functions etc., - displaying documentation for methods, members, etc. in the preview window, - fixing common coding errors, like missing semi-colons, typos, etc., - semantic renaming of variables across files, - formatting code, - removing unused imports, sorting imports, etc. Features vary by file type, so make sure to check out the [file type feature summary](#quick-feature-summary) and the [full list of completer subcommands](#ycmcompleter-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][]. Installation ------------ ### macOS 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 installat