Allow for no-results message in editor.action.goToLocations-command

[jdneo]

Is it possible to add the API to show the editor message?

The use case could be:

A extension registered a command in the context menu, and the user clicks on it. After the execution, show a editor message to provide some result hint.

[jrieken]

@jdneo Is this a problem that occurs when using editor.action.peekLocations but not having a result? I am not a fan of exposing the in-editor-message widget but I can easily tweak the command so that can show a message

[jdneo]

Thank you @jrieken!

In Java, we have a feature called go to super implementation (navigate to the implementation in the super type). Our current behavior is try to resolve it on hover, if it has a super implementation, then show the button in the hover information:

To better expose the feature, we hope to add it into the context menu as well. Something like this:

So we hope we can get the same experience when there is no result for this navigation, show the editor message, just like what VS Code has for go to definition, go to reference...

[jrieken]

Great. Than let's do this. The Java extension will call the editor.action.goToLocations command when it has its results and I will make sure it shows a message when called without results, e.g support an argument with a custom no result message

[jdneo]

@jrieken Pretty cool! That works for us!

Thank you!

[jrieken]

Alright, I'll try to get something in for tomorrow

[jrieken]

I have pushed those changes, this is how you call the api command

return vscode.commands.executeCommand(
	'editor.action.goToLocations',
	vscode.window.activeTextEditor.document.uri, // anchor uri and position
	vscode.window.activeTextEditor.selection.start,
	[], // results (vscode.Location[])
	'goto', // mode
	'No Foo Found' // <- message
);

The command is a bit more powerful than what "go to super" needs, e.g it can handle multiple results etc, just like "Go to References" etc. Still, with the snippet above you should be able to get what you need and be as close as possible to our native experience.

[jdneo]

Working like a charm!

[jrieken]

Adding verified based on the previous comment

[jdneo]

Hi @jrieken,

one more question: The API works fine when the location array is empty. Today I tried to add a location into it:

return commands.executeCommand(
    'editor.action.goToLocations',
    window.activeTextEditor.document.uri,
    window.activeTextEditor.selection.active,
    [targetLocation],
    'goto',
    'No super implementation found'
);

where the targetLocation is an object containing uri & range:

targetLocation = {
    uri: ...,
    range: ...,
};

Then I got an error: Unable to open 'Person.java': Invalid arguments.

Is that anything I missed here?

Thanks

---

Update:

Seems the range needs to be defined as:

range: {
	startLineNumber: xx,
	startColumn: xx,
	endLineNumber: xx,
	endColumn: xx,
}

which is different from the type defined in vscode.Range

@jrieken Does that mean we should still use the API window.window.showTextDocument() to do the navigation?

[jrieken]

where the targetLocation is an object containing uri & range:

The range must be an instance of vscode.Range otherwise this won't work. Can you confirm it is like that, e.g no lookalike type but the real thing?

[jdneo]

@jrieken

I tried to get a Range using the constructor, and failed to go to the target location.

targetLocation = {
    uri: Uri.parse(superImpl.uri),
    range: new Range(new Position(0, 0), new Position(0, 0)),
};

[jrieken]

Yeah, I see it now. There is something wrong

[jrieken]

Sorry, what must be is that the result array should be instances of vscode.Location-types. When calling commands we have special logic to check for that type which then turns it into the corresponding objects on the client side

[jdneo]

@jrieken Thank you! I should try to use the constructor of Location... 😃