dotansimha/graphql-code-generator

typed-document-node: camelCase exports by default?

Open

#6,585 opened on 2021年8月29日

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

説明

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?

コントリビューターガイド

技術スタック
typescriptgraphql
領域
backendtooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Familiarity with GraphQL code generationUnderstanding of TypeScript plugin config
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
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).