dotansimha/graphql-code-generator

Interfaces forcing c# 8.0, is this intended?

Open

#5.600 geöffnet am 24. Feb. 2021

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)TypeScript (1.295 Forks)batch import
help wantedkind/enhancementplugins

Repository-Metriken

Stars
 (10.341 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 22T 9h) (53 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Der Fehler liegt im C# Codegenerator Plugin von graphql code generator. Das Problem meldet, dass Schnittstelleneigenschaften mit einem 'public' Zugriffsmodifizierer generiert werden, was ein C# 8.0 Feature ist. Das erwartete Verhalten ist, das 'public' Schlüsselwort wegzulassen. Zur Behebung suchen Sie den C# Plugin Code, wahrscheinlich im Verzeichnis packages/plugins/c sharp. Entfernen Sie in der Template oder Generatorlogik, die Schnittstelleneigenschaften ausgibt, den 'public' Zugriffsmodifizierer. Prüfen Sie, ob es eine bedingte Logik gibt, die 'public' nur in bestimmten Kontexten hinzufügt. Testen Sie die Änderung mit einem Beispiel GraphQL Schema, das eine Schnittstelle enthält.
Tech Stack
csharpgraphqltypescript
Domain
developer experiencetooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Knowledge of GraphQL codegenFamiliarity with C# syntax
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70