dotansimha/graphql-code-generator

[typescript] Opt out of suffix for enum value keys

Open

#6.499 aberto em 18 de ago. de 2021

Ver no GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (1.295 forks)batch import
corehelp wantedkind/enhancement

Métricas do repositório

Stars
 (10.341 stars)
Métricas de merge de PR
 (Mesclagem média 22d 9h) (53 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Investigue a lógica de geração de código para tipos enum no plugin TypeScript, especificamente a configuração `typesSuffix`. Analise como os sufixos são aplicados tanto ao nome do enum quanto aos seus valores. Considere adicionar uma nova opção de configuração `suffixEnumValues` que permita desabilitar o sufixo nos valores do enum. A implementação provavelmente envolveria modificar o visitor de enum ou as funções de transformação do plugin TypeScript. Verifique os testes existentes para geração de enum para garantir compatibilidade com versões anteriores.
Pilha de tecnologia
typescript
Domain
developer experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75