Split large unions over multiple lines

[benjie]

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

✔️ Acknowledged. Think of this as the issue, to open the discussion via demonstration.

Please ignore whitespace changes when reviewing this PR.

Description

To make git management of changes easier, it's nice if lines aren't too long. Some of the lines emitted by graphql-code-generator can be excessively large which results in hard to review diffs. This PR aims to introduce newline splits in a few more places to make changes more surgical.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Tests have been updated.

Test Environment:

• OS: Ubuntu 24.04
• master branch
• NodeJS: v20.18.0

Checklist:

• I have followed the CONTRIBUTING doc and the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Notes:

• TypeScript GraphQL Request tests › works without variables and TypeScript GraphQL Request tests › returns first 3 entries tests fail locally for me on master. I have not investigated.
• This is to open a discussion so I've not made doc edits yet.

Further comments

I've currently gated this behind the printFieldsOnNewLines setting which seems related; I don't know if you'd want separate settings for each change, or a more general useNewlinesForUnions setting, or...?

This is also not an exhaustive change that adds newlines to all unions.

[changeset-bot]

⚠️ No Changeset found

Latest commit: cb59ef4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[eddeee888]

Hi @benjie , would there be a scenario where the existing behaviour (i.e. the equivalent of printFieldsOnNewLines=false) would be preferred?
If not, I wonder if we should just do this without a config option?

[benjie]

@eddeee888 Thanks for asking! I would 100% be in support of adding this without a config option. I don't know why anyone would want it all on one line, I was just trying to minimize codegen diff for people who didn't opt in.

[benjie]

It's going to be a little while before I can make that change - feel free to take over, or leave it for me in a few weeks time 👍