dotansimha/graphql-code-generator

[typescript] Opt out of suffix for enum value keys

Open

#6.499 geöffnet am 18. Aug. 2021

Auf GitHub ansehen
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)TypeScript (1.295 Forks)batch import
corehelp wantedkind/enhancement

Repository-Metriken

Stars
 (10.341 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 22T 9h) (53 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die Codegenerierungslogik für Enum Typen im TypeScript Plugin, insbesondere die `typesSuffix` Konfiguration. Betrachte, wie Suffixe sowohl auf den Enum Namen als auch auf seine Werte angewendet werden. Erwäge das Hinzufügen einer neuen Konfigurationsoption `suffixEnumValues`, die das Deaktivieren des Suffixes für Enum Werte ermöglicht. Die Implementierung würde wahrscheinlich die Änderung des Enum Visitors oder der Transformationsfunktionen des TypeScript Plugins beinhalten. Überprüfe vorhandene Tests für die Enum Generierung, um Abwärtskompatibilität sicherzustellen.
Tech Stack
typescript
Domain
developer experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75