microsoft / microsoft/TypeScript

Show function return type inlay hints even for JS functions that have explicit type annotations

Abierto
#45,928 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Domain: LS: Inlay Hints In Discussion Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

Suggestion

🔍 Search Terms

  • inlay hints
  • return type
  • function like
  • JavaScript

⭐ Suggestion

Currently the javascript.inlayHints.functionLikeReturnTypes.enabled setting in VS Code adds inlay hints to JS functions that do not have an explicit @return annotation:

// Shown here
function foo() /* : number */ { 
    return 1;
}

// But not here here
/** @return {number} */
function foo()  { 
    return 1;
}

This feels inconsistent, since I now have to look in different locations for the type information

I propose adding a new option that always enables these return types in JS files, even if there is an @return type annotation.

In the example above, this would result in the inlay hints showing on both functions:

function foo() /* : number */ { 
    return 1;
}

/** @return {number} */
function foo()  /* : number */ { 
    return 1;
}

This lets me read the code more like standard TypeScript

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

Comienza rastreando la configuración existente javascript.inlayHints.functionLikeReturnTypes.enabled y cómo se suprimen los tipos de retorno cuando hay una anotación @return. Define la interacción de la nueva opción con esa configuración y, después, verifica que tanto las funciones de JavaScript anotadas como las no anotadas muestren sugerencias insertadas del tipo de retorno cuando esté habilitada.

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
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.