dotansimha/graphql-code-generator

Interfaces forcing c# 8.0, is this intended?

Open

#5 600 ouverte le 24 févr. 2021

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)TypeScript (1 295 forks)batch import
help wantedkind/enhancementplugins

Métriques du dépôt

Stars
 (10 341 stars)
Métriques de merge PR
 (Merge moyen 22j 9h) (53 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le bug se trouve dans le plugin de génération de code C# de graphql code generator. Le problème signale que les propriétés d'interface sont générées avec un modificateur d'accès 'public', qui est une fonctionnalité de C# 8.0. Le comportement attendu est d'omettre le mot clé 'public'. Pour corriger, localisez le code du plugin C#, probablement dans le répertoire packages/plugins/c sharp. Dans le modèle ou la logique du générateur qui génère les propriétés d'interface, supprimez le modificateur d'accès 'public'. Vérifiez s'il existe une logique conditionnelle qui pourrait ajouter 'public' uniquement dans certains contextes. Testez le changement avec un schéma GraphQL d'exemple contenant une interface.
Stack technique
csharpgraphqltypescript
Domaine
developer experiencetooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Knowledge of GraphQL codegenFamiliarity with C# syntax
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70