dotansimha/graphql-code-generator

Interfaces forcing c# 8.0, is this intended?

Open

#5600 aperta il 24 feb 2021

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)TypeScript (1295 fork)batch import
help wantedkind/enhancementplugins

Metriche repository

Star
 (10.341 star)
Metriche merge PR
 (Merge medio 22g 9h) (53 PR mergiate in 30 g)

Descrizione

Describe the bug When we have an interface in the graphl schema the generated c# interface properties will have a public prefix making them a c# 8.0 feature.

Schema

interface Product {
  articles: [Article!]!
}

C#

public interface Product {
      [JsonProperty("articles")]
      public List<Article> articles { get; set; }
}

I guess the publicpart here should probably be omitted? Or is this intended?

  1. My GraphQL schema:
# Put your schema here
  1. My GraphQL operations:
# Put your operations here
  1. My codegen.yml config file:
overwrite: true
schema: "https://somedomain/graphql"
documents: "./src/graphql/**/*.graphql"
generates:
  ./src/GraphQL/Client/GraphQLClientServices.generated.cs:
    config:
      namespaceName: SomeNameSpace
      typesafeOperation: false
    plugins:
      - c-sharp
      - c-sharp-operations

Expected behavior I expect the output to not include the public part.

Environment:

  • OS: Windows / Git Bash
"@graphql-codegen/c-sharp-operations": "^1.18.0",
"@graphql-codegen/cli": "^1.20.1",
"@graphql-codegen/typescript": "^1.20.2",
"@graphql-codegen/typescript-graphql-request": "^3.0.2",
"@graphql-codegen/typescript-operations": "^1.17.14",
  • NodeJS: v14.15.1

Guida contributor

Direzione di ricerca
Il bug si trova nel plugin di generazione del codice C# di graphql code generator. Il problema segnala che le proprietà dell'interfaccia vengono generate con un modificatore di accesso 'public', che è una funzionalità di C# 8.0. Il comportamento atteso è omettere la parola chiave 'public'. Per risolvere, individuare il codice del plugin C#, probabilmente nella directory packages/plugins/c sharp. Nella logica del template o del generatore che produce le proprietà dell'interfaccia, rimuovere il modificatore di accesso 'public'. Controllare se esiste una logica condizionale che potrebbe aggiungere 'public' solo in determinati contesti. Testare la modifica con uno schema GraphQL di esempio contenente un'interfaccia.
Tech stack
csharpgraphqltypescript
Dominio
developer experiencetooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Knowledge of GraphQL codegenFamiliarity with C# syntax
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70