Documenting components with a docstring that appears on hover documentation

Problem

With React’s tooling, you can comment on a component like this:

/** Documentation that will appear on hover in other places where this is imported */
function MyComponent() { return null }

However, in Svelte, I haven’t found a way to do this.

Solution

I would like to know where I can place a comment that will be taken up by the on-hover documentation of editors like VSCode and Vim/Neovim (with coc.nvim).

To illustrate, here I’m hovering MyComponent but I only see import MyComponent:

I would like my docstring Documentation that will appear on hover in other places where this is imported to be included in the tooltip.

I’ve googled around for this for a while and tried my local setup with TypeScript and I can’t find a way to do it. I found an interesting related discussion on metadata for Svelte components but the discussion is more about prop types.

Question

On the analogous issue I made on language-tools https://github.com/sveltejs/language-tools/issues/280 we’ve been talking about HTML comments that can be picked up by svelte2tsx. However, using something like <svelte:options documentation="blabla" /> seems more idiomatic, but it would require support by the compiler.

What do you think is the best option?

[Conduitry]

Closing, as this does indeed sound like more of a language-tools thing.

[dummdidumm]

Yes, you are welcome to do a PR at language-tools 😃