microsoft / microsoft/TypeScript
Enums and interfaces do not have definitions in quick info/tooltips
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
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)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue に記載された enum と interface の例を使って、報告された quick-info の動作を、ローカルの場合とインポートした場合の両方で再現します。まず TypeScript の quick-info/tooltip エントリーポイントをたどり、次にこれらの宣言に対する既存の表示動作を特定します。ホバー時に、ローカルでの使用とインポートした場合の使用の両方で、それらの定義とメンバーが表示され、関連するテストが更新されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- developer-experience, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100