microsoft / microsoft/TypeScript
Show all JSDoc @typedef properties when forming object of that type
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
Issue Type: Feature Request
Problem
When making references to custom types, you cannot really see what that custom type actually is actually composed of.For example, I have a class called OnlineUser which takes an optional parameter of custom type OnlineUserOptions:

When hovering over a reference to the class or forming the object to pass as OnlineUserOptions, only the name of the type is shown in the documentation that is displayed. If you don't know/remember what properties comprise OnlineUserOptions, then the only way to find out is by beginning to type random characters:

Suggestion
It would be very useful if instead, as soon as you begin the object literal, it would show all the properties of the custom type, like so:
It would also be nice if it was possible to click on the name of the type to jump to its definition (maybe through use of the @link tag?) or hover over it to view its details as though you were hovering over its name in the actual @typedef.
VS Code version: Code 1.50.0 (93c2f0fbf16c5a4b10e4d5f89737d9c2c25488a3, 2020-10-07T06:10:52.432Z)
OS version: Windows_NT x64 10.0.19041
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
OnlineUserOptions のような JSDoc @typedef と、その型に渡されるオブジェクトリテラルを使用して、VS Code での動作を再現します。関連する TypeScript language-service の補完およびドキュメントの動作を調査します。オブジェクトを作成するときにすべての typedef プロパティが表示され、型から有用なナビゲーションまたはホバーの詳細を提供できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- developer-experience, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100