Expose EncodedSemanticClassificationsRequest in protocol.d.ts #42640
Conversation
|
Thanks for the PR! It looks like you've changed the TSServer protocol in some way. Please ensure that any changes here don't break consumers of the current TSServer API. For some extra review, we'll ping @sheetalkamat, @amcasey, @mjbvz, @minestarks for you. Feel free to loop in other consumers/maintainers if necessary |
typescript-bot
added
Author: Team
For Milestone Bug
| /** | ||
| * A request to get encoded semantic classifications for a span in the file | ||
| */ | ||
| interface EncodedSemanticClassificationsRequest extends FileRequest { |
There was a problem hiding this comment.
Do we also need to add the response types? We currently have to maintain a copy of them in VS Code: https://github.com/microsoft/vscode/blob/3d500ebd8b4a919e8631e916f417e5c68eb90d3f/extensions/typescript-language-features/src/languageFeatures/semanticTokens.ts#L275
There was a problem hiding this comment.
Aren’t they in typescript/tsserver .d.ts ?
There was a problem hiding this comment.
We currently only use protocol.d.ts with VS Code. I think this should have all the types used communicating from or to tsserver
src/server/protocol.ts
Outdated
| @@ -868,6 +866,14 @@ namespace ts.server.protocol { | |||
| format?: "original" | "2020" | |||
| } | |||
|
|
|||
| /** The response for a EncodedSemanticClassificationsRequest */ | |||
| export interface EncodedSemanticClassificationsResponse extends Response { | |||
| body?: { | |||
There was a problem hiding this comment.
Pull this out as EncodedSemanticClassificationsResponseBody interface
src/server/protocol.ts
Outdated
| export interface EncodedSemanticClassificationsResponse extends Response { | ||
| body?: { | ||
| endOfLineState: EndOfLineState; | ||
| spans: number[]; |
There was a problem hiding this comment.
Dont we need specific enum for classifications returned otherwise vscode would need separate list?
There was a problem hiding this comment.
Yeah, maybe, the spans looks like
* @returns a number array encoded as triples of [start, length, ClassificationType, ...].
When it's the older format, so I've included it but it's not referenced up here
|
Hi, just want to check if this is on track for TS 4.2.1. If not, could we please get this into a recovery build of TS 4.2 instead of waiting for TS 4.3? This would let us better validate the semantic highlighting support API while switching to the native TS implementation (aeschli/typescript-vscode-sh-plugin#22) |
|
Just updating the baselines, I'll also submit this to the 4.2 branch 👍🏻 |
src/server/protocol.ts
Outdated
| */ | ||
| export interface EncodedSemanticClassificationsResponseBody { | ||
| endOfLineState: EndOfLineState; | ||
| spans: ClassifiedSpan[] | number[]; |
There was a problem hiding this comment.
This isnt correct. The response currently from getEncodedSemanticClassifications returns type as ts.Classifications where spans is number[].
More over you are referencing ClassifiedSpan here which is only in services and not in protocol.
This doesnt correctly reflect what we return.
There was a problem hiding this comment.
Dang, I thought I reverted that, that's what I get for shipping late at night, Running baselines to update now and will double check before I ask for a re-review! Thanks
There was a problem hiding this comment.
OK, that looks good until we add some sort of wild syntax like spans: [...[number, number, ClassificationType][] ] heh
|
Cool, I'm going to replicate this for the 4.2 branch now |
…oft#42640) * Expose EncodedSemanticClassificationsRequest in protocol.d.ts * Adds the response for encoded semantic highlights too * Update types: * Also include classificationtype anyway * Fix feedback
#42965) * Expose EncodedSemanticClassificationsRequest in protocol.d.ts * Adds the response for encoded semantic highlights too * Update types: * Also include classificationtype anyway * Fix feedback
Fixes #42587 - I think because this request used to have the same args as many other requests then it was not included in the
protocol.d.ts.Now it differs, so I've removed the internal markers 👍🏻