Add a callback function for the Accept button of inline suggestion toolbar

[gugeonmo]

Inline Suggestion Toolbar

Current Feature

vscode/src/vscode-dts/vscode.proposed.inlineCompletionsAdditions.d.ts

Lines 42 to 56 in 620340c

	export interface InlineCompletionItemProvider {
	/**
	* @param completionItem The completion item that was shown.
	* @param updatedInsertText The actual insert text (after brackets were fixed).
	*/
	// eslint-disable-next-line local/vscode-dts-provider-naming
	handleDidShowCompletionItem?(completionItem: InlineCompletionItem, updatedInsertText: string): void;
	/**
	* Is called when an inline completion item was accepted partially.
	* @param acceptedLength The length of the substring of the inline completion that was accepted already.
	*/
	// eslint-disable-next-line local/vscode-dts-provider-naming
	handleDidPartiallyAcceptCompletionItem?(completionItem: InlineCompletionItem, acceptedLength: number): void;
	}

When we click "Accept Word" of the inline suggestion toolbar,
the function handleDidPartiallyAcceptCompletionItem is called
so that we can handle the event for partially accepted suggestion.

For the "Accept" button, however, we don't have a corresponding function.

New Feature

Can we add a function that is called when an inline completion item was fully accepted by the "Accept" button of the inline suggestion toolbar?

The function would look like as follows:

/**
* Is called when an inline completion item was fully accepted.
* @param completionItem The completion item that was shown.
*/
handleDidFullyAcceptCompletionItem?(completionItem: InlineCompletionItem): void;

[hediet]

You can set a command which is then called.

[gugeonmo]

@hediet Thank you for replying!

I am not sure if I understood your answer correctly.
Does setting a command mean writing a function body as follows?

handleDidPartiallyAcceptCompletionItem(completionItem: vscode.InlineCompletionItem, acceptedLength: number): void {
	console.log('handleDidPartiallyAcceptCompletionItem');
},

Then, how can I add a command for "full" accept event? (i.e., event for the Accept button was clicked)

[hediet]

there is a command propert yon the inline completion item itself

[gugeonmo]

@hediet I see. Thank you for the answer.

For those who need explanation, here is the main part of the code for handling the accept event using the property on the inline completion item.

export function activate(context: vscode.ExtensionContext) {
  function handleAccept() {
    console.log("Accepted");
  }
  vscode.commands.registerCommand('accept.command1', handleAccept);
  const provider: vscode.InlineCompletionItemProvider = {
    async provideInlineCompletionItems(document, position, context, token) {
      const result: vscode.InlineCompletionList = {
        items: [],
        commands: [],
      };
      // TODO: make suggestion text, position_range, and completeBracketPairs
      result.items.push({
        insertText: text,
        range: position_range,
        completeBracketPairs,
        command: {command: 'accept.command1', title: 'my title'},
      });
     return result
  }
};

[hediet]

dont forget to unregister your temporary commands!