dotansimha/graphql-code-generator

[typescript] Opt out of suffix for enum value keys

Open

#6 499 ouverte le 18 août 2021

Voir sur GitHub
 (2 commentaires) (2 réactions) (0 assignés)TypeScript (1 295 forks)batch import
corehelp wantedkind/enhancement

Métriques du dépôt

Stars
 (10 341 stars)
Métriques de merge PR
 (Merge moyen 22j 9h) (53 PRs mergées en 30 j)

Description

Is your feature request related to a problem? Please describe. It's a bit odd that suffixes are applied to enum values in addition to the enum itself (when using typesSuffix):

export enum RoleSuffix {
  UserSuffix = 'USER',
  AdminSuffix = 'ADMIN'
}

Normally the suffix is useful to disambiguate the overall type when importing and using it in files, but there is not much benefit to having a suffix on the values themselves in most cases (UserSuffix, for example).

Describe the solution you'd like Add a flag to opt out of this behavior. suffixEnumValues true/false

Guide contributeur

Direction de recherche
Étudiez la logique de génération de code pour les types enum dans le plugin TypeScript, en particulier la configuration `typesSuffix`. Examinez comment les suffixes sont appliqués à la fois au nom de l'enum et à ses valeurs. Envisagez d'ajouter une nouvelle option de configuration `suffixEnumValues` permettant de désactiver le suffixe sur les valeurs enum. La mise en œuvre impliquerait probablement de modifier le visiteur d'enum ou les fonctions de transformation du plugin TypeScript. Vérifiez les tests existants pour la génération d'enum afin de garantir la rétrocompatibilité.
Stack technique
typescript
Domaine
developer experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75