microsoft / microsoft/TypeScript
Show documentation for literals in intellisense
オープン
まだ誰も着手していません。
Awaiting More Feedback
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
Suggestion
When filling in a value where the expected type is a union of literals, intellisense is able to suggest the possible values.
However, it does NOT show the documentation associated with each literal:

This makes me tend to use enums instead, which has a more verbose syntax and requires an extra import.
Use Cases
Building and documented APIs in typescript will be nicer if we could just document the literals in a union.
Search Terms
- intellisense for string literals
- documentation for string literals
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、TypeScript におけるドキュメント化された文字列リテラルのユニオンに対する IntelliSense の補完を再現します。次に、リテラル候補に対する補完とドキュメントの動作を追跡し、各候補リテラルに関連付けられたドキュメントが表示されることを、enum の動作を変更せずに確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- developer-experience, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100