dotansimha/graphql-code-generator

typed-document-node: camelCase exports by default?

Open

#6,585 opened on Aug 29, 2021

View on GitHub
 (6 comments) (4 reactions) (0 assignees)TypeScript (10,341 stars) (1,295 forks)batch import
corehelp wantedkind/enhancementwaiting-for-answer

Description

First of all, thank you for this amazing plugin!

By default it generates TypedDocumentNodes in PascalCase. While it makes sense for all generated TypeScript types, it probably should be camelCase for nodes as they are values rather than types. For example, typescript-react-apollo generates functions that start with lowercase letters.

There's a config option namingConvention, but setting it to change-case-all#camelCase changes the case of types as well, which is not what we're looking for.

It also looks like omitOperationSuffix property doesn't work. Ideally, I would like to see the following being generated:

export const getUserQuery = ...;
export const deleteUserMutation = ...;

Is there a config property I'm missing?

Contributor guide

Tech stack
typescriptgraphql
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with GraphQL code generationUnderstanding of TypeScript plugin config
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the typed document node plugin in graphql code generator. Look at the default naming convention (PascalCase) and how it could be changed to camelCase for values only. Investigate the existing `namingConvention` config and the reported bug with `omitOperationSuffix`. Check plugin source files like `src/visitor.ts` and config interfaces. The issue asks for a way to set naming convention per entity type (values vs types).