microsoft / microsoft/TypeScript

Feat: Non-Detail view for Error Messages

Ouverte
#36,701 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Proposal Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner les captures d’écran de l’issue, le message simplifié proposé et les objectifs de conception TypeScript liés dans la checklist. Le travail est terminé lorsque les messages d’erreur peuvent présenter une forme concise tout en conservant les informations détaillées derrière un élément « See More », sans modifier le comportement à l’exécution.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.