Kite Autocomplete Plugin for Visual Studio Code
Go to file
2017-11-06 19:25:52 +01:00
.vscode VSCode boilerplate 2017-04-19 14:42:07 +02:00
assets Add a title to the examples list page 2017-10-23 11:12:38 +02:00
docker-image add back kite-installer 2017-05-10 17:02:55 -07:00
docs/images Moved user documentation to the top-level. Keep original readme as DEVELOPMENT.md 2017-11-06 19:25:52 +01:00
src Merge pull request #57 from kiteco/fix-behaviour 2017-11-03 08:10:36 -07:00
test 💚 Fix broken tests 2017-10-26 11:51:08 +02:00
.eslintrc.json VSCode boilerplate 2017-04-19 14:42:07 +02:00
.gitignore Remove unused files 2017-04-20 17:47:45 +02:00
.travis.yml Remove linux as CI target 2017-07-06 15:46:53 +02:00
.vscodeignore VSCode boilerplate 2017-04-19 14:42:07 +02:00
build_release.sh make executable 2017-05-15 20:36:45 -07:00
CHANGELOG.md VSCode boilerplate 2017-04-19 14:42:07 +02:00
DEVELOPMENT.md Moved user documentation to the top-level. Keep original readme as DEVELOPMENT.md 2017-11-06 19:25:52 +01:00
jsconfig.json VSCode boilerplate 2017-04-19 14:42:07 +02:00
LICENSE Update LICENSE 2017-05-26 12:03:56 -07:00
Makefile make sure to include rollbar, do not have quiet flag for the build 2017-05-24 15:16:45 -07:00
package.json ⬆️ 📦 kite-installer 2017-11-02 11:42:04 +01:00
README.md Moved user documentation to the top-level. Keep original readme as DEVELOPMENT.md 2017-11-06 19:25:52 +01:00
vsc-extension-quickstart.md VSCode boilerplate 2017-04-19 14:42:07 +02:00

Kite for Visual Studio Code

This extension adds support for Kite in Visual Studio Code and adds the features:

  • Completions
  • Function Signatures
  • Expanded Info
  • Goto Definition

How to install this extension

This extension is automatically installed by Kite when you select Visual Studio Code in the list of plugins.

Startup

When starting VSCode with Kite for the first time, a brief tour about Kite will be displayed in the active pane.

Kite Tour

This tour will only be displayed once. If you want to see it again on next startup you can activate the kite.showTourOnStartup setting.

Status Bar

The Kite icon in the status bar displays the state of Kite for the current file. Clicking on the icon will open the status panel with additional information.

kite status bar

The icon in the status bar can take three different colors:

  • blue: The Kite Engine is available and functioning properly.
    kite status ready
  • gray: There's either no open file or, if there's an active file, the file is either not supported or not whitelisted.
    kite status not whitelisted
  • red: Something went wrong when the plugin tried to contact the Kite service on your computer. Depending on the issue, the status panel can offer actions to solve the problem.
    kite status not running

Quick Info

kite hover

Hovering your mouse over a symbol will show you a popup with up to three links:

  • def will open the file where this symbol is defined (this may not be available if Kite cannot find the definition)
  • web will open the symbol documentation page in your browser
  • more will open the expand view with additional documentation for this symbol

Expanded View

The expanded view offers a more detailed view of a symbol. You can use the sidebar panel to browse the members of a module or a type, or to access curated examples, StackOverflow topics, and more.

Kite Expand Panel

Active search is available using the corresponding command from the command palette. It will open the search panel on the side.

Type a module, function or symbol name and browse the results in the panel.

Kite Active Search

Commands

Name Description
Kite Active Search Opens the active search panel on the side.

Settings

Name Description
kite.showTourOnStartup Whether or not to show the Kite tour on startup or not.
kite.pollingInterval The interval at which the extension checks the status of the Kite connection (defaults to 5s).