GraphQL Config - one configuration for all your GraphQL tools (supported by most tools, editors & IDEs). The easiest way to configure your development environment with your GraphQL Schema.

As a developer, you gain simplicity and a central place to setup libraries, tools and your IDE extensions.

As a library author GraphQL Config makes it easier to maintain the code responsible for handling configuration, loading GraphQL schemas or even files with GraphQL operations and fragments. GraphQL Config provides a set of useful methods and an easy-to-work-with API.

Example

schema: ./schema.json
documents: ./src/components/**/*.jsx

Installation and Usage

Visit our website graphql-config.com to learn more about the GraphQL Config.

Help & Community

Join our Discord chat if you run into issues or have questions. We love talking to you!

Contributions

Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!

And if this is your first time contributing to this project, please do read our Contributor Workflow Guide before you get started off.

Code of Conduct

Help us keep GraphQL Config open and inclusive. Please read and follow our Code of Conduct as adopted from Contributor Covenant

License

MIT

Change log

5.1.3

Patch Changes

• #1572 d95462c Thanks @dimaMachina! - revert cosmiconfig update to v8

5.1.2

Patch Changes

• #1489 9a89093 Thanks @that1matt! - Change minimatch to version 9

5.1.1

Patch Changes

• #1481 5d00c94 Thanks @renovate! - Update minimatch

5.1.0

Minor Changes

• #1459 5eca929 Thanks @dimaMachina! - - fix loading esm js config

  • add support of *.mjs configs

Patch Changes

• #1418 658f984 Thanks @dimaMachina! - should not throw pattern is too long from minimatch dependency when SDL schema contain more than 65536 characters

5.0.3

Patch Changes

• #1406 69afec4 Thanks @B2o5T! - fix SchemaPointer type, allow both URLs with headers and local type definitions

5.0.2

Patch Changes

• #1370 156e7c2 Thanks @gilgardosh! - Bump bob-the-bundler

5.0.1

Patch Changes

• #1359 18bfca8 Thanks @n1ru4l! - Fix esm compatibility

5.0.0

Major Changes

• #1348 42ffb2e Thanks @n1ru4l! - Drop support for Node.js 14. Require Node.js >= 16

Patch Changes

• #1294 1d11dbd Thanks @renovate! - dependencies updates:

  • Updated dependency jiti@1.18.2 ↗︎ (from 1.17.1, in dependencies)

• #1348 42ffb2e Thanks @n1ru4l! - dependencies updates:

  • Updated dependency @graphql-tools/graphql-file-loader@^8.0.0 ↗︎ (from ^7.3.7, in dependencies)
  • Updated dependency @graphql-tools/json-file-loader@^8.0.0 ↗︎ (from ^7.3.7, in dependencies)
  • Updated dependency @graphql-tools/load@^8.0.0 ↗︎ (from ^7.5.5, in dependencies)
  • Updated dependency @graphql-tools/merge@^9.0.0 ↗︎ (from ^8.2.6, in dependencies)
  • Updated dependency @graphql-tools/url-loader@^8.0.0 ↗︎ (from ^7.9.7, in dependencies)
  • Updated dependency @graphql-tools/utils@^10.0.0 ↗︎ (from ^9.0.0, in dependencies)

• #1358 d6ead74 Thanks @n1ru4l! - dependencies updates:

  • Updated dependency cosmiconfig@^8.1.0 ↗︎ (from 8.1.0, in dependencies)
  • Updated dependency jiti@^1.18.2 ↗︎ (from 1.18.2, in dependencies)
  • Updated dependency minimatch@^4.2.3 ↗︎ (from 4.2.3, in dependencies)
  • Updated dependency string-env-interpolation@^1.0.1 ↗︎ (from 1.0.1, in dependencies)

4.5.0

Minor Changes

• 9e4f453 Thanks @kamilkisiela! - Support ESM and .mts/.cts config extensions

4.4.1

Patch Changes

• #1245 bad5090 Thanks @B2o5T! - fix peerDependenciesMeta was not included in package.json

4.4.0

Minor Changes

• #1189 ab2ad6d Thanks @B2o5T! - add cosmiconfig-toml-loader to peerDependenciesMeta

• #1171 b52dc1b Thanks @B2o5T! - move cosmiconfig-typescript-loader in peerDependencyMeta

4.3.6

Patch Changes

• #1149 a12f394 Thanks @charlypoly! - conflict with codegen also using TypeScriptLoader(), causing a double ts-node register.

4.3.5

Patch Changes

• #1126 cc781c4 Thanks @n1ru4l! - dependencies updates:

  • Updated dependency cosmiconfig-typescript-loader@^4.0.0 ↗︎ (from ^3.1.0, in dependencies)

4.3.4

Patch Changes

• #1103 2c568f1 Thanks @renovate! - dependencies updates:

  • Added dependency tslib@^2.4.0 ↗︎ (to dependencies)

• #1103 2c568f1 Thanks @renovate! - Proper ESM/CJS support on Node.js

4.3.3

Patch Changes

• cd7747e: bump cosmiconfig-typescript-loader to resolve errors with esm loading

4.3.2

Patch Changes

• f74d648: fix: change to maintained version of cosmiconfig-typescript-loader

4.3.1

Patch Changes

• 44eec8d: Add workaround for default import of typescript config loader to fix ESM support

4.3.0

Minor Changes

• aaccd04: feat: improve types to fix JSON schema when schema is passed like object with headers

Patch Changes

• 18d07fd: fix: rollback GraphQLConfig.projects to empty object instead Object.create(null)

4.2.0

Minor Changes

• 0636e9a: feat: support graphql.config.cjs config
• 55f078a: feat: update graphql-tools packages

Patch Changes

• fix: update minimatch dependency

Thanks to @bfanger for his first contribution 0636e9a

vNEXT

v4.0.2

• Update range of @graphql-tools/merge dependency to include v7 and v8

v4.0.1

• Updated dependencies of graphql-tools to latest, to address issues related to documents loading.

v4.0.0

‼️ ‼️ ‼️ BREAKING CHANGE ‼️ ‼️ ‼️

Dropped Node 10 support, due to the need to support ESM in this package.

‼️ ‼️ ‼️ BREAKING CHANGE ‼️ ‼️ ‼️

The signature of Loader has been changed in graphql-tools, to allow more flexibility.

If you are using graphql-config with extensions, then the Extension you are using needs to adjust to the new return value of Loader signature that returns Source[] | null instead of Source. (see: https://github.com/kamilkisiela/graphql-config/issues/716)

Other changes:

• ESM Support
• Update dependencies of graphql-tools.

v3.4.0

Note: A breaking chnage snuk into that version, please see v4.

• Update dependencies of graphql-tools.

v3.3.0

• Add support for loading the config from package.json #693 by @ionut-botizan

v3.2.0

• Allow custom options for loadSchema #593

v3.1.0

• TOML and TypeScript loaders #595 by @acao
• Add ability to override default loaders #583 by @danielrearden

v3.0.2

• Fix missing types #542

v3.0.1

• use GraphQL Toolkit v0.10.6

v3.0.0

Read the Migration chapter

• Support GraphQL v15
• Support CommonJS and ES Modules
• Support environment variables with default values
• Match a file with a GraphQL Project
• JSON Schema
• New Extensions system with Loaders
• includes and excludes becomes include and exlude
• New field documents - defines GraphQL Operations and Fragments
• Broader spectrum of config file names
• Support custom config name
• Synchonous version
• Support legacy #437
• Extensions capable of modifying GraphQL Schemas #463

Prior to v3

Changes: https://github.com/kamilkisiela/graphql-config/releases