`graphql-codegen-client-preset`: support configurable document/fragment variable suffixes

Open
#610 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
graphql, rust
Domain
tooling

Research direction

Start at the graphql-codegen-client-preset SWC plugin and compare its generated import identifiers with the upstream codegen options listed in the issue. Verify how document and fragment prefixes, suffixes, deduplication, and omitted operation suffixes should affect names. Done means all six options are configurable while preserving the current defaults.

Written by the indexing model from the issue text.

Description

The plugin hardcodes "Document" and "FragmentDoc" when generating import identifiers for operations and fragments.

This means if you set documentVariableSuffix: '' in your codegen config (a supported option), the plugin generates mismatched imports - it looks for GetUserDocument but codegen exports GetUser.

The upstream codegen has several options that affect variable names:

  • documentVariablePrefix / documentVariableSuffix
  • fragmentVariablePrefix / fragmentVariableSuffix
  • dedupeOperationSuffix
  • omitOperationSuffix

None of these are currently configurable in the SWC plugin.

I have a PR ready that adds all six options with backwards-compatible defaults.

Dominant language
Rust
Stars
389
Forks
106
Avg merge
10m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from swc-project/plugins

All issues in swc-project/plugins

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.