microsoft / microsoft/TypeScript

Support labels in template string

Ouverte
#57,385 4 commentaires 2 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

template string label
template string name
interpolation label

✅ Viability Checklist
⭐ Suggestion

The idea is to allow the addition of labels into a template literal.
This has no effect on the type itself in any way, the sole purpose is to give a better DX.

These labels would be shown by IntelliSense in order to provide the same experience as labels for the tuple labels.

📃 Motivating Example
// Template literal today
type Options = {
   name: `${string}/${string}`;
}

// With labels
type Options = {
   name: `${scope: string}/${baseName: string}`;
}
💻 Use Cases

This would offer a slightly better DX.
Right now you can document the parts of the template in a JSDoc comment, but the JSDoc is not preserve by IntelliSense in some cases.

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 l’exemple motivant de template literal et comparez-le au comportement IntelliSense existant des étiquettes de tuple référencé dans l’issue. Le travail est terminé lorsque les étiquettes de template literal améliorent la documentation IntelliSense sans modifier le type ni le comportement du JavaScript généré.

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

Évaluation

Stack technique
typescript
Domaine
compilers, developer-experience
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.