dotansimha/graphql-code-generator

[typescript] Opt out of suffix for enum value keys

Open

#6,499 opened on 2021年8月18日

GitHub で見る
 (2 comments) (2 reactions) (0 assignees)TypeScript (10,341 stars) (1,295 forks)batch import
corehelp wantedkind/enhancement

説明

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

コントリビューターガイド

技術スタック
typescript
領域
developer experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Familiarity with graphql code generatorUnderstanding of TypeScript enums
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
Investigate the code generation logic for enum types in the TypeScript plugin, specifically the `typesSuffix` configuration. Look at how suffixes are applied to both the enum name and its values. Consider adding a new configuration option `suffixEnumValues` that allows disabling the suffix on enum values. The implementation would likely involve modifying the TypeScript plugin's enum visitor or transform functions. Check existing tests for enum generation to ensure backward compatibility.