Prototype definition and span API #40045
Conversation
**Problem** See microsoft#10037 **Proposal** Add a new `DefinitionAndSpan` class to the VSCode API. This bundles up a location and the span of the defining symbol
| @@ -1896,6 +1896,13 @@ declare module 'vscode' { | |||
| resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>; | |||
| } | |||
|
|
|||
| export class DefinitionAndSpan { | |||
There was a problem hiding this comment.
We may want to make this use a single definition instead:
class DefinitionAndSpan {
span: Location;
definition: Location;
}My original thinking was to bundle the concept of a definition into a class, i.e. this text range corresponds to these X definitions. However I'm not sure this makes sense since we later flatten out the definition list in the UI anyways
| @@ -1896,6 +1896,13 @@ declare module 'vscode' { | |||
| resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>; | |||
| } | |||
|
|
|||
| export class DefinitionAndSpan { | |||
There was a problem hiding this comment.
Also, I'm thinking of renaming this type. Something like DefinitionAndDefiningSpan or BoundedDefinition perhaps
| @@ -50,19 +66,19 @@ function getDefinitions<T>( | |||
| } | |||
|
|
|||
|
|
|||
| export function getDefinitionsAtPosition(model: IReadOnlyModel, position: Position): TPromise<Location[]> { | |||
| export function getDefinitionsAtPosition(model: IReadOnlyModel, position: Position): TPromise<DefinitionAndSpan[]> { | |||
There was a problem hiding this comment.
Change currently breaks the vscode.executeDefinitionProvider command. It previously returned Location[] but will now return a DefinitionAndSpan[]
|
Not a fan... It's seems overly specific for that one bug. It is under-specified with respect to what the If this is just about fixing #10037 we should look into something simpler, e.g. not just checking the first at the position but also the token and take the token if it's truly (w/o whitespace) larger than the word. Or use some the logical-selection-logic (F1 > Expand Select). Wrt new API I'd favour something more AST'ish like a new provider that can answer questions like 'What's the range of the symbol/token at this position?', 'What's the range of the container at this position?' etc. That could solve this issue and improve the preview-logic (and maybe even the shrink/expand selection feature) |
|
@jrieken Yes the intent here is that we return the symbol-name range for the hover. The main use case I have is for strings in TS, either import paths or string literal types. Another example without strings would be markdown link definitions, such as [a][some ref]
[some ref]: http://example.comI'd be interested to see if any other extension authors have also run into this limitation My first though was to use the tokens but that seems specific to #10037. The Can you explain the other APIs where this additional information would be helpful. The new provider option seems promising but I'm not sure if it makes sense to decouple the defining symbol span from the definitions in this way (for example, are there cases where a language would want to return different ranges for a hover vs a definition?). Maybe a new method on |
|
Superseded by #45249 |
Problem
See #10037
Proposal
Add a new
DefinitionAndSpanclass to the VSCode API. This bundles up a location and the span of the defining symbol. Allow definition providers to return either aLocationor aDefinitionAndSpan