API InlineCompletions Finalised

[isidorn]

We have finalized the Inline Completions API. This allows extensions to provide inline completions that are decoupled from the suggestion widget. An inline completion is rendered as if it was already accepted, but with a grey color. Users can cycle through suggestions and accept them with the Tab key.

An example extension that uses Inline Completions is GitHub Copilot.

More information can be found in the vscode.d.ts file with the entrypoint into the API being languages.registerInlineCompletionItemProvider.

Try out this API and we are very excited to see what you will build with it. Feedback is very much appreciated!

fyi @hediet

[PEZ]

Sounds very cool! Do we have some guidance somewhere around when to use which type of completion?

[hediet]

We generally recommend to use the normal completion item provider (it is much better to explore completions). There also is a user-setting to show completion items as inline completions.

[PEZ]

My extension has default bindings for both tab and esc with when clauses to not interfere with suggest widgets and the like. It doesn't work with these inline suggestions because I can't find a when context to guard with. Is there such a context? If not, is there some other way I can disable my bindings when inline suggestions are showing?

Tracking this on Calva here: BetterThanTomorrow/calva#1781

[PEZ]

I think I have figured it out. The default inline suggest keybindings uses this when context for accepting a suggestion with tab:

inlineSuggestionHasIndentationLessThanTabSize && inlineSuggestionVisible && !editorTabMovesFocus

For dismissing, simply inlineSuggestionVisible is used.

[Qinyun718]

Hi, Could I know when the inline completion api would be available in the official vscode (not the insider version)? Thank you!

[isidorn]

It is available in VS Code stable since 3 weeks.

[juli1]

How may I start using this API? Is there any specific changes to do in my package.json or any dependency to start using it?

Is there any example of how to use it?

[isidorn]

@juli1 it should work with 1.68.1. If it does not that seems like a bug and can you please file a new issue in the VS Code github repo with reproducable steps. Thank you

[juli1]

@juli1 it should work with 1.68.1. If it does not that seems like a bug and can you please file a new issue in the VS Code github repo with reproducable steps. Thank you

I just imported the examples and the plugin shows multiple errors when starting. This seems to be a plugin that still relies on API proposals since the package.json file defines enabledApiProposals. Even after removing the enabledApiProposals, the message is still there. This is what is happening when launching the example.

That is kind of sad to see how this feature is being released when it was being used by GitHub for a brand new feature and not being available to all the rest of the developer ecosystem. And still lack documentation and support as of today.

I will file a bug. What repository should I file an issue with? Any link to the repository?

Other question: it seems that any extension that wants to use the inline completion has to use vscode-dts, adding more steps in the package.json. Any plan for when @types/vscode will contain the new signatures? Using vscode-dts is totally understandable when a API was proposed, it would be good to be able to not use it since this is finalized and released in production releases.

Thanks,

[juli1]

Bumping this thread - any update on this?

[isidorn]

Sorry for the slow response I was on vacation. Please file an issue here https://github.com/microsoft/vscode/issues
Thank you

[talbright]

Bump. This looks like its still in a proposed state? https://github.com/microsoft/vscode/blob/main/src/vscode-dts/vscode.proposed.inlineCompletionsAdditions.d.ts

What are the blockers that remain?

[nandooliveira]

Is it possible to listen for events when an inline completion was accepted, even from a different extension?

[nandooliveira]

@isidorn

[isidorn]

I think not.