microsoft / microsoft/TypeScript

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

Ouverte
#45,928 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Domain: LS: Inlay Hints In Discussion Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

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

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 retracer le fonctionnement du paramètre existant javascript.inlayHints.functionLikeReturnTypes.enabled et la manière dont les types de retour sont supprimés lorsqu’une annotation @return est présente. Définissez l’interaction de la nouvelle option avec ce paramètre, puis vérifiez que les fonctions JavaScript annotées comme non annotées affichent des indications inline du type de retour lorsqu’elle est activée.

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é
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

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