JSDoc-style comments in hovertext

[paarthenon]

I'd love to have jsdoc-style comments rendered in the popover. It would help my consumers parse some of my more inscrutable types and give a closer simulation of the experience of using the utilities involved. I'm also interested in using that hypothetical feature to show how documentation is retained from a template to the generated object. Has this come up before? Would you consider it in scope for twoslash?

[orta]

I have thought about it a bit yeah - I'm open to it but I think this should probably be an opt-in behavior. E.g. it's hidden behind a flag like includeJSDocInHover. Though I'm open to having my mind changed once I try it.

For the TS website, I opted against it because most of the time it's a distraction from the thing I'm trying to teach (types) - but most people aren't necessarily using shiki-twoslash the same way.

It would require reusing this info from @typescript/twoslash

[orta]

I added this flag, but it doesn't seem to be doing much in the Jest website https://github.com/facebook/jest/pull/11657

Either the Jest types don't have jsdoc (feasible) or the flag doesn't work (also feasible)

[paarthenon]

Hi Orta!

Thanks for such a fast turnaround on this. I got the chance to try it, and it is indeed working. I'm going to experiment with it some more over the next day or two, but here are a couple of things I noticed:

• It will pick up documentation defined within the file itself, which is fantastic for me.
• Overloaded functions will not render docs. Instead, they will show the multiple signatures.
• I don't see a clear break between the doc-text and the type-text. Would you be open to a delimiter or storing the content in separate data attributes? I'd like to do some postprocessing like formatting markdown comments or stealing Fatih Kalifa's syntax highlighting, but I understand that may not be in scope for the base library. This may also have value in giving more control over the import ______ suffix that seems to accompany external imports. Apologies if this is already possible, I'm still in the shallows.
  • This may also help if users want to change the order of the output to match VS Code's rendering.

Thanks again