microsoft / microsoft/TypeScript

Feat: Non-Detail view for Error Messages

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

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

Needs Proposal Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Suggestion

The following is a case where I'm missing a single field from an object:

Screen Shot 2020-02-08 at 6 08 45 PM Screen Shot 2020-02-08 at 6 08 57 PM Screen Shot 2020-02-08 at 6 09 02 PM

The amount of detail in this error message is very useful for extreme scenarios, but in a general day to day scenario, it's a bit overwhelming.

It would be really nice to have detailed messages like this hidden behind a "See More" item, and instead show the simplest form of the error. In this case the error could be

missing prop "fields" of type "object"

I don't need to know what the object type is, or what the parent type is. I can just get that error message later.

Use Cases

Almost 100% of the errors I get in TypeScript would be improved by this. It's very rare that I want to know all the information, and almost always that I just want a simple reminder of what tiny slip up it is.

Checklist

My suggestion meets these guidelines:

  • 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. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

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

はじめの一歩

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

調査の方向性

まず、issue のスクリーンショット、提案されている簡略化されたメッセージ、およびチェックリストでリンクされている TypeScript の設計目標を確認します。エラーメッセージが簡潔な形式で表示でき、詳細情報を「See More」項目の背後に保持できるようになり、ランタイムの動作を変更しなければ作業は完了です。

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

評価

技術スタック
javascript, typescript
領域
compilers
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

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

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