TypeScript enumsAsConst adds typesPrefix to fields

Aperta Adatta ai principianti
  • Qualcosa non va?
#11,079 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
77/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
graphql, typescript
Ambito
backend-api-design, tooling

Direzione di ricerca

L’issue menziona @graphql-codegen/typescript e fornisce una riproduzione che usa enumsAsConst con typesPrefix. Inizia individuando il codice di generazione degli enum e i test correlati in quel pacchetto, quindi esegui il test pertinente oppure riproduci lo schema e la configurazione forniti. Il lavoro è completato quando i valori dell’enum const rimangono A, B e C e il nome dell’enum mantiene il prefisso Prefix.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Which packages are impacted by your issue?

@graphql-codegen/typescript

Describe the bug

I noticed this change during my upgrade from @graphql-codegen/core 5.0.0->6.2.2, @graphql-codegen/typescript 5.0.7->6.1.2.

Your Example Website or App

Code below

Steps to Reproduce the Bug or Issue
import { codegen } from "@graphql-codegen/core";
import * as typescriptPlugin from "@graphql-codegen/typescript";
import { parse, buildASTSchema } from "graphql";

const baseSchemaDoc = parse(`
type MyType {
  field: String!
}

enum MyEnum {
  A
  B
  C
}
`);

const baseSchema = buildASTSchema(baseSchemaDoc);

let output = await codegen({
  filename: "output_test.ts",
  schema: baseSchemaDoc,
  schemaAst: baseSchema,
  plugins: [
    {
      typescript: {
        typesPrefix: "Prefix",
        skipTypename: true,
        enumsAsConst: true,
      } as typescriptPlugin.TypeScriptPluginConfig,
    },
  ],
  pluginMap: {
    typescript: typescriptPlugin,
  },
  documents: [],
  config: {},
});

console.log(output);
Expected behavior

I should have seen the following output:

export const PrefixMyEnum = {
  A: 'A',
  B: 'B',
  C: 'C'
} as const;

But instead saw:

export const PrefixMyEnum = {
  PrefixA: 'A',
  PrefixB: 'B',
  PrefixC: 'C'
} as const;

Note: changing enumsAsConst to false correctly generates the enum without the field prefixes:

export enum PrefixMyEnum {
  A = 'A',
  B = 'B',
  C = 'C'
}
Screenshots or Videos

No response

Platform
Codegen Config File

No response

Additional context

No response

Lingua principale
TypeScript
Stelle
11.3k
Fork
1.4k
Merge medio
1g 11h
PR unite (30g)
54

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di dotansimha/graphql-code-generator

Tutte le issue di dotansimha/graphql-code-generator

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.