microsoft / microsoft/TypeScript
Investigate eagerly returning more information about suggestions
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
Problem
Suggestions VS Code have three broad UX parts:
- Name/label. Primary identifier for a suggestion, such as
foo. - Details. Type information or auto import info, such as
string. - Documentation. Js doc info and additional details about the suggestion item
Currently VS Code only shows the details of the currently active suggestion. This can be problematic in cases like auto imports, where multiple symbols may all have the same name:
This design also reflects the design of the suggestion api:
completionInforeturns the entire list of suggestions, but only includes the namecompletionEntryDetailsreturns the details and documentation for an individual suggestion
Investigation
With https://github.com/microsoft/vscode/issues/39441, VS Code is exploring letting languages/extensions return the details part of the suggestion eagerly. This would let VS Code show details for the entire list of suggestions instead of just for the active one. In the auto import case specifically, this would likely mean showing the file paths we would import from.
We would like the typescript team's feedback on these idea and our current proposals:
- What information would be most helpful to render in the main suggestion list?
- How much overhead would returning this information add? Both in terms of message size and TS server computation time?
/cc @jrieken For VS Code apis
/cc @amcasey @minestarks for VS
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずこの issue とリンクされている VS Code issue #39441 を読み、ここで説明されている completionInfo API と completionEntryDetails API を比較してください。メインリストで役立つ候補の詳細と、メッセージサイズおよび TypeScript サーバーの計算コストについて調査してください。完了の条件は、TypeScript チームのフィードバックを文書化するか、明確な提案に到達することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript, vscode
- 領域
- developer-experience, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100