microsoft / microsoft/TypeScript

Allow merging enums with undefined

Ouverte
#56,579 0 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

enum merge undefined

✅ Viability Checklist
⭐ Suggestion

It can sometimes be useful to augment the types for a module to indicate that an exported enum is optional. There's no way I can find in TypeScript to do that right now. "Enum declarations can only merge with namespace or other enum declarations."

📃 Motivating Example

For example API consumers may need to support versions of a package that don't include a recently added enum.

How about allowing a ? before the { for an enum?

declare module 'typescript' {
  enum JSDocParsingMode? {}
}
💻 Use Cases

In typescript-eslint we want to always treat ts.JSDocParsingMode as optional. It was added in a more recent version of TypeScript than our backwards compatibility extends. But there's no way to mark it as | undefined.

Even if we do remember to always ts.JSDocParsingMode?.ParseAll and so on, doing so violates https://typescript-eslint.io/rules/no-unnecessary-condition.

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, test ou point d’entrée spécifique n’est nommé. Commencez par examiner comment les déclarations d’enum sont fusionnées et comment l’augmentation de module à l’origine de cette demande est vérifiée par le système de types. Ce sera terminé lorsqu’il existera un moyen pris en charge de marquer l’enum exporté comme optionnel tout en respectant les contraintes de compatibilité et d’exécution indiquées.

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

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

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