search

orta / vscode-twoslash-queries

VS Code extension which adds support for twoslash queries into typescript projects
https://marketplace.visualstudio.com/items?itemName=Orta.vscode-twoslash-queries
MIT License
419 stars 15 forks source link

alternative name suggestion: `inlay type hint comments` #33

Closed scarf005 closed 1 year ago

scarf005 commented 1 year ago

Summary

related: #20

Renaming the extension to inlay type hint comments might make it easier for users to find this extension.

Motivation

Although this extension is great, I had a hard time finding it on the marketplace (even when I've already installed it). My instinct was to search for names like:

however it wasn't easy to find:

comment type (19th) type inlay hint comment (not in screen) typescript comment type hint (not in screen)

Rationale

There are only two extensions using the name twoslash, and it might not be conventional to refer to // comments as twoslash comments. Since English isn't my first language, I struggled to figure out that twoslash meant the same thing as //.

Whereas the term inlay hint is officially used in VS Code settings, it might be easier to search for.

twoslash settings

orta commented 1 year ago

Twoslash is: https://shikijs.github.io/twoslash/

I'm not against adding those terms in the description etc, but it is the twoslash syntax in vscode and I'm not really planning on renaming it. I'd recommend focusing that energy on figuring out the right want to recommend it get inlined to vscode: https://github.com/microsoft/TypeScript/issues/52839

scarf005 commented 1 year ago

i see. thanks for the clarification.