microsoft / microsoft/TypeScript

Suggest argument names based on type definition of callback functions

Abierto
#40,335 1 comentario 5 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

No se nombran archivos de implementación ni pruebas. Comienza con el ejemplo enlazado de TypeScript Playground y revisa cómo se comportan actualmente en el editor las sugerencias de parámetros de callback. Se considera completado cuando los nombres de los argumentos de una definición de tipo de callback se ofrecen como sugerencias sin cambiar el JavaScript emitido.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.