Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for VSCode whole-line autocomplete #351

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
49 changes: 49 additions & 0 deletions docs/intellicode-visual-studio-code-completions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: VS Code Completions Preview
description: Read an overview of IntelliCode for Visual Studio Code. The IntelliCode extension provides AI-assisted IntelliSense for Python, Java, TypeScript, and JavaScript.
ms.custom: SEO-VS-2020
ms.date: 04/19/2022
ms.prod: visual-studio-family
ms.technology: intellicode
ms.topic: conceptual
author: aayim
ms.author: aayim
manager: andster
---

# IntelliCode Completions Preview for Visual Studio Code

The [IntelliCode Completions extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode-completions) is an experimental extension which predicts up to a whole line of code based on your current code context.

![IntelliCode Completions for Python in Visual Studio Code](../images/wlc.gif)

This extension may contain unstable, experimental code. The IntelliCode team is focused on iterating rapidly and new functionality will be added.

### How to use

![IntelliCode Completions interpreting IntelliSense completion list selection in Visual Studio Code](../images/intellisenseSelection.gif)

Completions will appear after your cursor as you type, with a faded color. When the IntelliSense list is open, its selection is used to inform the whole-line autocompletion.

At any time you can accept the suggestion by pressing the tab key (you will need to press it twice if the IntelliSense list is visible). If you don't want to accept the suggestion, you can just keep on typing or press ESC
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change "tab" to "TAB" to keep it consistent with "ESC"


To enable experimental support for JavaScript and TypeScript, search for `intellicodeCompletions.language` in the Settings menu.

### Installation

The extension can be aquired at the following link: [IntelliCode Completions extension for VS Code](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode-completions)

The extension is supported by Visual Studio Code November 2021 Release 1.63 or later.

## Provide feedback

If you encounter a problem, you can browse [existing issues](https://github.com/MicrosoftDocs/intellicode/issues) and upvote them using a 👍 "thumbs up" reaction. If you don't see your particular problem, we'd love to hear from you. Include any **Output** window log entries from Visual Studio IntelliCode, Python, Java, JavaScript, or TypeScript with the bug.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be helpful to include a screenshot of how to do this


## See also

- [IntelliCode for Visual Studio](intellicode-visual-studio.md)
- [IntelliCode general FAQ](faq.yml)




17 changes: 8 additions & 9 deletions docs/intellicode-visual-studio-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ The [IntelliCode extension for Visual Studio Code](https://marketplace.visualstu

![IntelliCode for Python in Visual Studio Code](media/python-intellicode.gif)

## Supported languages

The supported languages for AI-assisted IntelliSense completions are:
IntelliCode provides AI-assisted IntelliSense completions for the following languages:

- Java
- JavaScript and TypeScript
- Python
- SQL

## Prerequisites

To install the extension, you need Visual Studio Code October 2018 Release 1.29 or later.
### Prerequisites

The extension is supported by Visual Studio Code June 2021 Release 1.58 or later.

AI-assisted IntelliSense for Java requires Java 8 Update 151 or higher.

To get AI-assisted IntelliSense for Java, you need Java 8 Update 151 or higher. (If you have a previous Java 8 version, you'll see the error **java.security.InvalidKeyException: Illegal key size**, and IntelliCode AI-assisted IntelliSense recommendations won't work.)

## Troubleshoot

This section provides some troubleshooting tips for common problems.
This section provides some troubleshooting tips for common problems with IntelliCode.

### No completion lists

Expand Down Expand Up @@ -67,15 +67,14 @@ If you see IntelliSense completion lists, but none of the completion items are s
As a first step, try updating to Visual Studio Code 1.30 or later, and [turning on network proxy support](https://code.visualstudio.com/updates/v1_30#_network-proxy-support-for-extensions) .

If turning on network proxy support doesn't work for you, check the corresponding [github issue](https://github.com/MicrosoftDocs/intellicode/issues/4) and let us know more.

- If you're a Java user experiencing the error message **java.security.InvalidKeyException: Illegal key size**, check to make sure you're using Java 8 Update 151 or later.
- Is there an actionable message that helps?

If you're still facing a problem, look through the [existing issues](https://github.com/MicrosoftDocs/intellicode/issues) or open a new one.

## Provide feedback

If you encounter a problem, you can browse [existing issues](https://github.com/MicrosoftDocs/intellicode/issues) and upvote them using a 👍 "thumbs up" reaction. If you don't see your particular problem, click the **Send feedback about** > **This product** button at the bottom of this page to create a new issue. Include any **Output** window log entries from Visual Studio IntelliCode, Python, Java, JavaScript, TypeScript, or SQL with the bug.

## See also

- [IntelliCode for Visual Studio](intellicode-visual-studio.md)
Expand Down
6 changes: 4 additions & 2 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For more information and to sign up for news and updates, see [Visual Studio Int

Before you begin, ensure you have a version of Visual Studio or Visual Studio Code that supports IntelliCode. The minimum requirements are:

- Visual Studio Code October 2018 Release 1.29 or later
- Visual Studio Code June 2021 Release 1.58 or later
- Visual Studio 2019 (Release 16.4 or higher, any edition)

The following table contains details about how to obtain IntelliCode for your development environment:
Expand All @@ -40,7 +40,9 @@ IntelliCode provides AI-assisted IntelliSense in both Visual Studio and Visual S
The completion list suggests the most likely correct API for a developer to use rather than presenting a simple alphabetical list of members. To provide this dynamic list, IntelliCode uses the developer's current code context as well as patterns based on thousands of highly rated, open-source projects on GitHub. The results form a model that predicts the most likely and most relevant API calls.

![C# Whole line completions in Visual Studio](media/intellicode-vs-wlc-small.png)
C# developers in Visual Studio 2022 and higher also benefit from [Whole line completions](visual-studio-whole-line-completions.md) which predict the next chunk of your code based on your current code so far, and present it as an inline prediction.
C# developers in Visual Studio 2022 and higher also benefit from [whole-line autocompletions](visual-studio-whole-line-completions.md) which predict the next chunk of your code based on your current code so far, and present it as an inline prediction.

Python, JavaScript, and TypeScript developers using Visual Studio Code Release 1.63 or higher can also benefit from whole-line autocompletions through a [new preview extension for Visual Studio Code](intellicode-visual-studio-code-completions.md).

## Visual Studio features
Check the [overview of IntelliCode for Visual Studio](intellicode-visual-studio.md) for full details of the additional features supported for Visual Studio users, such as [IntelliCode suggestions](intellicode-suggestions.md).
Expand Down