dotansimha/graphql-code-generator-community

External document import handling mismatch between `typescript-vue-apollo` and `typescript-vue-urql`

Open

#137 opened on Jul 12, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (195 forks)github user discovery
help wanted

Repository metrics

Stars
 (136 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug While trying to share types between urql-vue and vue-apollo, there seems to be some mismatches in how data is being referenced.

The issue I'm seeing is when importing document types using

        documentMode: "external",
        importDocumentNodeExternallyFrom: "./graphql-documents"

typescript-vue-apollo will reference the document types in camelCase, while typescript-vue-urql on the other hand will use PascalCase. I can change the naming of the document file (which lets me satisfy either Vue or Urql), but I can't however find a way to override how it's being referenced from the other files.

Additionally, typescript-vue-urql will not reference the document types properly, as it does not add the required prefix (like vue-apollo does). I've tried setting documentVariablePrefix: "Operations.", but the generated code omits the trailing ., so it becomes OperationsUser instead of Operations.User.

(Also related: https://github.com/dotansimha/graphql-code-generator/issues/6303 )

To Reproduce See https://codesandbox.io/s/eloquent-pine-lqgjo?file=/graphql-urql.ts

Contributor guide

Research direction
Compare the document variable prefix handling in the typescript vue apollo and typescript vue urql plugins. Trace how documentMode and importDocumentNodeExternallyFrom affect the generated code, particularly the casing and prefix inclusion. Check for any overrides or configuration options that could align the behavior.
Tech stack
typescript
Domain
apitooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GraphQLGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60