microsoft / microsoft/TypeScript

Suggest argument names based on type definition of callback functions

Ouverte
#40,335 1 commentaire 5 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Search Terms

callback, arguments, parameters, suggestion, auto correct

Suggestion

Let's say I have a type definition for my function like this:

function acceptsCallback(callback: (argumentNameThatIsVeryLong: string) => void) {}

When using it, that argumentNameThatIsVeryLong is a very good candidate for my argument name. I want to accept it but there is no way but typing it:

Screen Shot 2020-08-31 at 5 22 34 PM

Use Cases

When users are extremely lazy this is very handy! ;) In all seriousness this can avoid bugs by suggesting the right argument name. For instance when req and res objects are misplaced in an Express middleware by mistake

Examples

https://www.typescriptlang.org/play?#code/GYVwdgxgLglg9mABAQwhApgBygZwMLIA2hARqgNYAUERpFAXIpcgE4DmIAtumFAHLJuAFQAWyKAEkcANXQsAngBkEbRjigsYYNgEpEAXgB8iAG5wYAEz0BvAL4Aoe6gzZ8tMhCqPv95ux32OkA

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

Aucun fichier d’implémentation ni test n’est indiqué. Commencez par l’exemple lié de TypeScript Playground et examinez le comportement actuel des suggestions de paramètres de callback dans l’éditeur. La tâche est terminée lorsque les noms des arguments d’une définition de type de callback sont proposés sans modifier le JavaScript généré.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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