dotansimha/graphql-code-generator

Interfaces forcing c# 8.0, is this intended?

Open

#5.600 aberto em 24 de fev. de 2021

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (1.295 forks)batch import
help wantedkind/enhancementplugins

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

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

Guia do colaborador

Direção de pesquisa
O bug está no plugin de geração de código C# do graphql code generator. O problema relata que as propriedades da interface são geradas com um modificador de acesso 'public', que é um recurso do C# 8.0. O comportamento esperado é omitir a palavra chave 'public'. Para corrigir, localize o código do plugin C#, provavelmente no diretório packages/plugins/c sharp. No template ou na lógica do gerador que gera as propriedades da interface, remova o modificador de acesso 'public'. Verifique se há alguma lógica condicional que possa adicionar 'public' apenas em certos contextos. Teste a alteração com um esquema GraphQL de exemplo contendo uma interface.
Pilha de tecnologia
csharpgraphqltypescript
Domain
developer experiencetooling
Tipo Issue
Bug
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.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Knowledge of GraphQL codegenFamiliarity with C# syntax
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70