Convert "hover" action to return MarkedContent instead of MarkedString #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
apexskier
commented
Oct 1, 2020
|
|
||
| export interface JSONWorkerContribution { | ||
| getInfoContribution(uri: string, location: JSONPath): Thenable<MarkedString[]>; | ||
| getInfoContribution(uri: string, location: JSONPath): Thenable<Hover["contents"]>; |
There was a problem hiding this comment.
This is a wider type, so is fully backwards compatible.
|
Thanks a lot! We have this client capability that is passed when service is created: It lets the API user control whether the hover can use Markdown. Now with the MarkedContent we should probably observe that capability. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MarkedStringis deprecated by the LSP, and an editor I'm working in isn't escaping it properly. This updates the hover action to returnMarkedContentinstead ofMarkedString[]. As part of this, it can now return plain text usingMarkedKind.PlainText, which avoids some markdown escaping. I've maintained this package's custom extension to Schemas to support markdown content documentation though.Additionally, I've added some basic tests for hover contributions (resolves #53) and replaced the deprecated
assert.deepEqualmethod in these tests.