microsoft / microsoft/TypeScript

Considering limiting hover length

オープン
#37,648 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

TypeScript Version: 3.7.x-dev.201xxxxx

Search Terms: hover, length

Code

// A *self-contained* demonstration of the problem follows...
// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc.

Expected behavior: JSDocs can always be shown

Actual behavior: JSDocs is hidden because hover is too long

image

image

Playground Link: https://www.typescriptlang.org/play/#code/FAegVGwARlAqALApgTygYwPYFsAOAbAQwEsA7JAEygBcFDqoBHAV2PQGsoyAzTKXgE79mpdNWKZSAZygB3ZAKRRCNFLiW5CAwtiTUkQ4jJ4HFVan0KkomAEYArJGIxWoAcz1RFhfPjQA3A1tMKSUyKFJMBkCBNGZQ7mZ8OUIUKQAaZVIqYjxMAWoraj8aBCMbWyl0ZkUZWiUAKQBlABFMdAwcXVJqKQA6KABJBlCkbBl8YnYlesVATAIZAUwcGj5c3CXA0qUWNk4ePiQAD3UBYiRRJQUlAAoyfW0xYi3jzWyQLF9CXFCAfgBKTK2ZgMeooOZUWxXb64NDEbhQABqTSgAGFMBQlPZ4iMEJhZJRtlBmm0OpJVrgBgBRQhSc5CCxQUZyOgMQZQXSucKEJ6STJSPjsxTobz6KgqKoXLQSJm5YhEBl8eT0bZoKR4glUXQALmgsAAApptNgmMwDGhEDszbF+PkoLYiAh7Y7nYQEHqoPrjjoCEgPQADQP2KQe7hkCgAeXINwA3q6nQBff4AbgDgY9HoAgtlVlAKHwBbpaGQ3Hn4dwDBdqLqYFA0-7g6Hw1GkLHbZggVpMsr9DEoEn63qQMBMegFUpEqJxOSw9kWwAeOAAPhuLHN2vg-w3AAUltgjEh5wAlJCEfOkPyLpdL1OgECmvZcUi8KDXYCzyPRmPQGzkDcARnSH9qFkTANwAJiAqBSkUJANwAZig20ag3AAWJCw0CDcAFYkLpI4NwANjwpBAlIDcAHYkKQYg3AQasoAADmAAcgA

Related Issues: https://github.com/microsoft/vscode/issues/92787

It seems certain type hover will be formatted to one property each line. I'm wondering if you could only adopt this behavior when the total lines do not exceed a threshold (like 10 lines), so it wouldn't affect JSDocs.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

提供された Playground Link を使ってまず hover の動作を再現し、リンクされている VS Code issue も含めて、期待される表示と実際の表示を比較します。hover のフォーマット動作を調査し、短い type hover を変更せずに JSDoc の可視性を維持するために、行数のしきい値をどのように設定できるかを判断します。長い hover でも JSDoc が引き続き表示され、短い hover では提案されたフォーマットが維持されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
developer-experience
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。