/SublimeYouCompleteMe

YCMD plugin for Sublime Text

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

SublimeYouCompleteMe

A plugin for Sublime Text 3 that acts as a client of an YCMD server. This plugin is heavily based on YouCompleteMe.

Note: I have ported the plugin from Sublime Text 2 to Sublime Text 3, because version 3 can be used for free now!

YCMD enables powerfull general autocomplete for every language, and more indepth sementic completion for some, e.g.: python, c, c++

The following preview shows the general autocomplete and displaying of diagnostics in action. alt tag

SublimeYouCompleteMe is currently in the very early stages of development. Currently it is only tested on 64bit windows, with 64bit sublime text 3 and 64bit python 2.7.8.

Current features

  • Starts the YCMD server and keeps it alive.
  • ycm_goto command (ctrl+t, ctrl+t) - Jump to the declaration/definition of the symbol under the first cursor.
  • ycm_goto_history command (ctrl+t, ctrl+b) - Jump to the location before ycm_goto
  • ycm_auto_complete command (ctrl+space) - Force semantic autocomplete list to pop up. YCMD can also decide on it's own to use semantic autocomplete. For example when typing "." or "->" in the C-family languages.
  • Highlights diagnostics (compiler errors) that YCMD reports when loading or modifying a file. When a highlighted piece of code is selected, the detailed error text is shown in the statusbar and with a popup close to your cursor. This only works for the C-family of languages.
  • The diagnostics are now also shown when you have been idle (stopped typing for 2 seconds). This does not interfere with the autocomplete window and is shown next to it.

Installation for 64bit windows

  1. Clone this repository into your sublime text 3 packages folder.

    cd C:\Users\<yourname>\AppData\Roaming\Sublime Text 3\Packages
git clone https://github.com/ivankoster/SublimeYouCompleteMe

  2. Use git submodule to download some dependencies

    cd SublimeYouCompleteMe
git submodule update --init

  3. Now you need YCMD and the libclang library. YCMD is rather annoying to build on windows, but there is a precompiled .zip package provided in SublimeYouCompleteMe releases. Check the latest release and download the .zip package.

  4. Copy the ycmd/ folder in the above package to your <sublime_packages>/SublimeYouCompleteMe/ycmd folder.

  5. Make sure you have a 64bit version of python 2.7 installed. The plugin searches first in the default installation path (C:\python27\python.exe) if not found it searches in your PATH environment variable.

  6. Start Sublime Text 3. It should now work!