Repository files navigation

This Code Intelligence plugin forSublime Textprovides an interface toCodeIntel.CodeIntel is a code intelligence engine that was ported fromOpen Komodo Editor to a stand-alone Python package.

CodeIntel supports all the languages Komodo Editor supports for Code Intelligence(CIX, CodeIntel2) and a few others:

ActionScript, Django, Docker, EJS, epMojo, HTML, KomodoSnippet,LaravelBlade, Mason, Mustache, MXML, PHP, R, reStructuredText, RHTML,Smarty, TracWiki, TemplateToolkit, Twig, XBL, XML, XSLT, XUL, Python,Python3, Ruby, Perl, Go, ECMAScript, JavaScript, Node.js, CSS, SCSS, Sass,Less, HTML5, Tcl, C/C++, Objective-C.

The plugin provides the following features:

• Jump to Symbol Definition - Jump to the file and line of thedefinition of a symbol.
• Imports autocomplete - Shows autocomplete with the availablemodules/symbols in real-time.
• Function Call tooltips - Displays information in the status barabout the working function.

The package should work on all three platforms (MacOS X, Windows, and Linux).

Before installingSublimeCodeIntel, you must ensure thatCodeIntel is installedon your system. To installCodeIntel, do the following:

1. InstallPython andpip (Python 3 requires pip3).

2. InstallCodeIntel by typing the following in a terminal:

   # For Python 2[sudo] pip install --upgrade --pre CodeIntel# For Python 3[sudo] pip3 install --upgrade --pre CodeIntel

Note:SublimeCodeIntel requiresCodeIntel 2.0 or later.

With the Package Control plugin: The easiest way to installSublimeCodeIntel is through Package Control, which can be found atthis site:http://wbond.net/sublime_packages/package_control

Once you install Package Control, restart Sublime Text and bring up theCommand Palette (Command+Shift+P on OS X,Control+Shift+P onLinux/Windows). Select "Package Control: Install Package", wait whilePackage Control fetches the latest package list, then selectSublimeCodeIntel when the list appears. The advantage of using thismethod is that Package Control will automatically keep SublimeCodeIntelup to date with the latest version.

**Without Git:** Download the latest source fromGitHub and copythe whole directory into the Packages directory.

**With Git:** Clone the repository in your Sublime Text Packagesdirectory, located somewhere in user's "Home" directory:

git clone git://github.com/SublimeCodeIntel/SublimeCodeIntel.git

The "Packages" packages directory is located differently on differentplatforms. To access the directory use:

• OS X:

  Sublime Text -> Preferences -> Browse Packages...

• Linux:

  Preferences -> Browse Packages...

• Windows:

  Preferences -> Browse Packages...

• Start typing code, as usual, autocomplete will pop up whenever it'savailable. SublimeCodeIntel will also allow you to jump aroundsymbol definitions even across files with just a click ..and back.

  For Mac OS X:

  • Jump to definition =Control+Click
  • Jump to definition =Control+Command+Alt+Up
  • Go back =Control+Command+Alt+Left
  • Manual Code Intelligence =Control+Shift+space

  For Linux:

  • Jump to definition =Super+Click
  • Jump to definition =Control+Super+Alt+Up
  • Go back =Control+Super+Alt+Left
  • Manual Code Intelligence =Control+Shift+space

  For Windows:

  • Jump to definition =Alt+Click
  • Jump to definition =Control+Windows+Alt+Up
  • Go back =Control+Windows+Alt+Left
  • Manual Code Intelligence =Control+Shift+space

Don't despair! The first time you use it it needs to build some indexesand it can take more than a few seconds.

It just works!

For adding additional library paths (Django and extra libs paths forPython or extra paths to look for .js files for JavaScript for example),either add those paths as folders to your Sublime Text project ormodify SublimeCodeIntel User settings. User settings can be configuredin the User File Settings:

Do NOT edit the default SublimeCodeIntel settings. Your changes will belost when SublimeCodeIntel is updated. ALWAYS edit the userSublimeCodeIntel settings by selecting "Preferences->PackageSettings->SublimeCodeIntel->Settings - User". Note that individualsettings you include in your user settings willcompletely replacethe corresponding default setting, so you must provide that setting inits entirety.

Available settings:

• A list of disabled languages can be set using"disabled_languages". Ex."disabled_languages": ['css']
• Live autocomplete can be disabled by setting "live" tofalse.
• Information for more settings is available in theSublimeCodeIntel.sublime-settings file in the package.

If you are having problems or SublimeCodeIntel seemsslow/unresponsive/non-working, there are some things you should try:

1. Make sure the SublimeCodeIntel is not being treated as an ignoredpackage.
2. Regenerate indexing database.
3. Open a new issue.

To make sure Sublime Text didn't add SublimeCodeIntel to the list ofignored packages (this happens some times when packages are beinginstalled/upgraded):

• Select thePreferences/Settings - Default menu item
• Find theignored_packages setting and remove SublimeCodeIntel fromthe list.

To force re-indexation of the code intelligence database you need tofollow these steps:

• Close Sublime Text
• Open a terminal or navigate through your directories to find thedirectory~/.codeintel that containscodeintel.log,VERSIONand the directorydb. In Windows, this should be at%userprofile%\.codeintel.
• Delete the whole directory~/.codeintel and all of its content.Particularly, if you want to delete only the indexes, the code intelligence database indexes are located inside~/.codeintel/db.
• Start Sublime Text
• Try doing some code intelligence with the files in your project andenjoy a clean re-indexing! (Remember that the database is beingregenerated with this procedure, so you'll see it takes some time toautocomplete the first few times, you'll have to wait a bit forthings to be fast again)

If the problems persist after trying the above solutions, open a newissue inhttps://github.com/SublimeCodeIntel/SublimeCodeIntel/issues/

When opening new issues, please check no other issues exist which reportthe same problem and provide all the messages from the Sublime Textconsole (the console is accessed via thectrl+` shortcut or theView > Show Console menu) and the~/.codeintel/codeintel.log file(%userprofile%\.codeintel\codeintel.log in Windows) as well asmentioning the Sublime Text version, the platform you are using and thelanguages you are using the code intelligence on.

v3.0.0 (unreleased, beta):

• Uses CodeIntel as an OOP command and package. Needs to installCodeIntel with pip:pip install --upgrade --pre CodeIntel

v2.2.0 (2015-03-26):

• Fixed issue with tabs and autocomplete

The plugin is based on code from the Open Komodo Editor and has an MPL license.

Ported from Open Komodo by German M. Bravo (Kronuz).