Skip to content
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

Proposed expandable hover API #59940

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Proposed expandable hover API #59940

wants to merge 17 commits into from

Conversation

gabritto
Copy link
Member

@gabritto gabritto commented Sep 11, 2024

VSCode counterpart: microsoft/vscode#228255

This is an incomplete prototype of expandable hovers using the [current vscode proposed expandable hover API].

Mainly the only scenario implemented so far is for hovering over variables, e.g.:

type A = number | string;
type B = symbol | boolean;
type SomeType<T, U> = {
    propA: T,
    propB: U,
};

let a: A; // Hover on `a` will be expandable
let b: B; // Hover on `b` will be expandable
let someVar: SomeType<A, B>; // Hover on `someVar` will be expandable

Also not implemented yet is computing the upper limit of verbosity level. This means you'll always be able to click the + button on the UI, even if nothing will be expanded.

@typescript-bot typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Sep 11, 2024
@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.

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.

2 participants