Enums and interfaces do not have definitions in quick info/tooltips

[LAITONEN]

The issue might be related to this one, but mine is not about version 3.0, and is not solely about imports.

Search Terms

enum, description, definition, pop-up, tooltip, vs code, interface, suggestion

Suggestion

Hovering over enums and interfaces, should show their definition, i.e. I have this enum (or an interface):

enum enumName {
    ONE = 1;
    TWO = 2;
    THREE = 3;
}

If I hover over this enum, wherever I use it (whether it is imported to another file or used locally where it is declared), I would like to see what this enum is all about (essentially what are the properties).

This is what I see right now when I hover over enums or interfaces:

As a workaround, I currently need to add this type of JSDoc comments right above the enum declaration.

/** Props:
*    @param ONE 1;
*    @param TWO 2;
*    @param THREE 3;
*/

Which yields to:

Use Cases

This feature would save time & effort.
The shortcoming of the current approach is that either need to add ${2+numberOfEnumProperties} lines of comments or go to the file, where enum is declared, locate the enum there and then familiarize myself with its properties.

Examples

Checklist

I am not that experienced to be able to answer the questions below.

• This wouldn't be a breaking change in existing TypeScript / JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. new expression-level syntax)

[LAITONEN]

Also, if I have interface, which extends another interface:

interface One {
    one: number;
}

interface Two extends One {
    two: string;
}

And I use interface Two somewhere and hover over it, I will get the same dull description as I got on the second screenshot in the initial post with interfaceName, so not only there is no description of a specified properties, but it does not even show which interfaces it extends.

[mhegazy]

I agree. hovering over a type name to get a pop-up with the same text is rather useless. we can do better.

[ro-savage]

Just adding on to this. I find it really annoying that the type information for interfaces and enums are basically useless.

It also affects all the IDEs when they display the definitions. See this one for JetBrains IDE's: https://youtrack.jetbrains.com/oauth?state=%2Fissue%2FWEB-44531

[ro-savage]

Could someone point out where in the code base these definitions are created, and especially where the Types one are vs the Interface.

Then maybe someone from the community can take a look at actioning this.

[orta]

My tactic for figuring out stuff like this is to enable TSServer logging, perform the action you're interested in, then see what requests were made:

    {"seq":270,"type":"request","command":"quickinfo","arguments":{"file":"/Users/ortatherox/dev/typescript/new-website/packages/sandbox/src/typeAcquisition.ts","line":15,"offset":15}}

So this request is a quickinfo - a search I the codebase finds getQuickInfoAtPosition - which is where the code starts - my bet, the code you're looking for is in SymbolDisplay.getSymbolDisplayPartsDocumentationAndSymbolKind.