dotansimha/graphql-code-generator

[typescript] Opt out of suffix for enum value keys

Open

#6,499 创建于 2021年8月18日

在 GitHub 查看
 (2 评论) (2 反应) (0 负责人)TypeScript (10,341 star) (1,295 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.