Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update GraphQL Codegen (major) #515

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Update GraphQL Codegen (major) #515

merged 1 commit into from
Nov 19, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 13, 2024 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@graphql-codegen/add (source) ^3.2.3 -> ^5.0.3 age adoption passing confidence
@graphql-codegen/cli (source) ^2.16.5 -> ^5.0.3 age adoption passing confidence
@graphql-codegen/fragment-matcher (source) ^2.0.1 -> ^5.0.2 age adoption passing confidence
@graphql-codegen/introspection (source) ^2.2.3 -> ^4.0.3 age adoption passing confidence
@graphql-codegen/named-operations-object (source) ^2.3.1 -> ^3.1.0 age adoption passing confidence
@graphql-codegen/near-operation-file-preset (source) ^2.5.0 -> ^3.0.0 age adoption passing confidence
@graphql-codegen/typescript (source) ^2.8.8 -> ^4.1.1 age adoption passing confidence
@graphql-codegen/typescript-operations (source) ^2.5.13 -> ^4.3.1 age adoption passing confidence

Release Notes

dotansimha/graphql-code-generator (@​graphql-codegen/add)

v5.0.3

Compare Source

Patch Changes

  • #​9987 5501c62 Thanks @​taro-28! - Export configuration types (e.g. AddPluginConfig) from the entry point.

    import type { AddPluginConfig } from '@​graphql-codegen/add';

v5.0.2

Compare Source

Patch Changes

v5.0.1

Compare Source

Patch Changes

v5.0.0

Compare Source

Major Changes
Patch Changes

v4.0.1

Compare Source

Patch Changes

v4.0.0

Compare Source

Major Changes
Patch Changes
dotansimha/graphql-code-generator (@​graphql-codegen/cli)

v5.0.3

Compare Source

Patch Changes

v5.0.2

Compare Source

Patch Changes

v5.0.1

Compare Source

Patch Changes

v5.0.0

Compare Source

Major Changes
Patch Changes

v4.0.1

Compare Source

Patch Changes

v4.0.0

Compare Source

Major Changes
Patch Changes

v3.3.1

Compare Source

Patch Changes

v3.3.0

Compare Source

Minor Changes

  • #​9151 b7dacb21f Thanks @​'./user/schema.mappers#UserMapper',! - Add watchPattern config option for generates sections.

    By default, watch mode automatically watches all GraphQL schema and document files. This means when a change is detected, Codegen CLI is run.

    A user may want to run Codegen CLI when non-schema and non-document files are changed. Each generates section now has a watchPattern option to allow more file patterns to be added to the list of patterns to watch.

    In the example below, mappers are exported from schema.mappers.ts files. We want to re-run Codegen if the content of *.mappers.ts files change because they change the generated types file. To solve this, we can add mapper file patterns to watch using the glob pattern used for schema and document files.

    // codegen.ts
const config: CodegenConfig = {
  schema: 'src/schema/**/*.graphql',
  generates: {
    'src/schema/types.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        mappers: {

          Book: './book/schema.mappers#BookMapper',
        },
      }
      watchPattern: 'src/schema/**/*.mappers.ts', // Watches mapper files in `watch` mode. Use an array for multiple patterns e.g. `['src/*.pattern1.ts','src/*.pattern2.ts']`
    },
  },
};

    Then, run Codegen CLI in watch mode:

    yarn graphql-codegen --watch

    Now, updating *.mappers.ts files re-runs Codegen! 🎉

    Note: watchPattern is only used in watch mode i.e. running CLI with --watch flag.

Patch Changes

v3.2.2

Compare Source

Patch Changes

v3.2.1

Compare Source

Patch Changes

v3.2.0

Compare Source

Minor Changes
Patch Changes

v3.1.0

Compare Source

Minor Changes

  • #​8893 a118c307a Thanks @​n1ru4l! - It is no longer mandatory to declare an empty plugins array when using a preset

  • #​8723 a3309e63e Thanks @​kazekyo! - Introduce a new feature called DocumentTransform.

    DocumentTransform is a functionality that allows you to modify documents before they are processed by plugins. You can use functions passed to the documentTransforms option to make changes to GraphQL documents.

    To use this feature, you can write documentTransforms as follows:

    import type { CodegenConfig } from '@​graphql-codegen/cli';

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: [
        {
          transform: ({ documents }) => {
            // Make some changes to the documents
            return documents;
          },
        },
      ],
    },
  },
};
export default config;

    For instance, to remove a @localOnlyDirective directive from documents, you can write the following code:

    import type { CodegenConfig } from '@​graphql-codegen/cli';
import { visit } from 'graphql';

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: [
        {
          transform: ({ documents }) => {
            return documents.map(documentFile => {
              documentFile.document = visit(documentFile.document, {
                Directive: {
                  leave(node) {
                    if (node.name.value === 'localOnlyDirective') return null;
                  },
                },
              });
              return documentFile;
            });
          },
        },
      ],
    },
  },
};
export default config;

    DocumentTransform can also be specified by file name. You can create a custom file for a specific transformation and pass it to documentTransforms.

    Let's create the document transform as a file:

    module.exports = {
  transform: ({ documents }) => {
    // Make some changes to the documents
    return documents;
  },
};

    Then, you can specify the file name as follows:

    import type { CodegenConfig } from '@​graphql-codegen/cli';

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: ['./my-document-transform.js'],
    },
  },
};
export default config;
Patch Changes

v3.0.0

Compare Source

Major Changes
Patch Changes
dotansimha/graphql-code-generator (@​graphql-codegen/fragment-matcher)

v5.0.2

Compare Source

Patch Changes

v5.0.1

Compare Source

Patch Changes

v5.0.0

Compare Source

Major Changes
Patch Changes

v4.0.1

Compare Source

Patch Changes

v4.0.0

Compare Source

Major Changes
Patch Changes

v3.3.3

Compare Source

Patch Changes

v3.3.2

Compare Source

Patch Changes

v3.3.1

Compare Source

Patch Changes

v3.3.0

Compare Source

Minor Changes
Patch Changes

v3.2.1

Compare Source

Patch Changes

v3.2.0

Compare Source

Minor Changes
  • 97ddb48: feat: GraphQL v16 compatibility
Patch Changes

v3.1.0

Compare Source

Minor Changes
Patch Changes

v3.0.0

Compare Source

Major Changes

  • b0cb13d: Update to latest graphql-tools and graphql-config version.

    ‼️ ‼️ ‼️ Please note ‼️ ‼️ ‼️:

    This is a breaking change since Node 10 is no longer supported in graphql-tools, and also no longer supported for Codegen packages.

Patch Changes
dotansimha/graphql-code-generator (@​graphql-codegen/introspection)

v4.0.3

Compare Source

Patch Changes

v4.0.2

Compare Source

Patch Changes

v4.0.1

Compare Source

Patch Changes

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the major Major Dependency Bumps that contain tentitive breaking changes get marked with this label label Nov 14, 2024
@manuelblum manuelblum added the dependencies Pull requests that update a dependency file label Nov 14, 2024
@renovate renovate bot changed the title chore(deps): update graphql codegen (major) Update GraphQL Codegen (major) Nov 15, 2024
@renovate renovate bot force-pushed the renovate/major-graphql-codegen branch 2 times, most recently from d1a6c9e to 2366d75 Compare November 18, 2024 11:28
@renovate renovate bot force-pushed the renovate/major-graphql-codegen branch from 2366d75 to 0ecdc54 Compare November 18, 2024 11:50
@johnnyomair johnnyomair merged commit 6fcc890 into main Nov 19, 2024
3 checks passed
@johnnyomair johnnyomair deleted the renovate/major-graphql-codegen branch November 19, 2024 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnnyomair johnnyomair johnnyomair approved these changes

@dkarnutsch dkarnutsch Awaiting requested review from dkarnutsch

@fraxachun fraxachun Awaiting requested review from fraxachun

@manuelblum manuelblum Awaiting requested review from manuelblum

@nsams nsams Awaiting requested review from nsams

@thomasdax98 thomasdax98 Awaiting requested review from thomasdax98

Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file major Major Dependency Bumps that contain tentitive breaking changes get marked with this label
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@johnnyomair @manuelblum