Skip to content

Modify interactive inlay hints API to be more backwards compatible #55274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 5, 2023

Conversation

jakebailey
Copy link
Member

@jakebailey jakebailey commented Aug 4, 2023

This tweaks the API in #54734 to make it such that it's less likely to break consumers and require changes such as microsoft/monaco-editor#4100.

Unfortunately, this will require another vscode change to modify https://github.com/microsoft/vscode/pull/189344/files.

@typescript-bot
Copy link
Collaborator

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, @mjbvz, @zkat, and @joj for you. Feel free to loop in other consumers/maintainers if necessary.

@typescript-bot
Copy link
Collaborator

Looks like you're introducing a change to the public API surface area. If this includes breaking changes, please document them on our wiki's API Breaking Changes page.

Also, please make sure @DanielRosenwasser and @RyanCavanaugh are aware of the changes, just as a heads up.

@DanielRosenwasser
Copy link
Member

CC @mjbvz

Comment on lines +166 to 169
hintText = "";
}
else {
hintText += ":";
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't want to leave this blank, we'd need to drop the reassignment in the first branch, and then pull the code out of the second branch to make it unconditional. I.e., add the prop only when requested and everything else stays the same.

Happy to do whatever. Not sure which is better.

@DanielRosenwasser DanielRosenwasser merged commit 87c986c into microsoft:main Aug 5, 2023
@jakebailey jakebailey deleted the inlay-hints-protocol branch August 5, 2023 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants