graphql-config

What is graphql-config?

The graphql-config npm package provides a set of utilities to make it easier to configure and use GraphQL in your development environment. It allows for the centralization of GraphQL project configurations, making it simpler to share settings across different tools such as IDEs, GraphQL clients, and other utilities that work with GraphQL.

What are graphql-config's main functionalities?

Loading GraphQL Project Configuration

This feature allows you to load the GraphQL project configuration. The `loadConfig` function asynchronously loads the configuration from the default or specified configuration file.

const { loadConfig } = require('graphql-config');

async function main() {
  const config = await loadConfig();
  console.log(config);
}

main();

Getting Schema Information

This feature enables you to retrieve the GraphQL schema information from the configuration. It's useful for tools and applications that need to introspect the schema.

const { loadConfig } = require('graphql-config');

async function main() {
  const config = await loadConfig();
  const schema = await config.getDefault().getSchema();
  console.log(schema);
}

main();

Working with Endpoints

This feature allows for the management of GraphQL API endpoints within the configuration. It simplifies the process of switching between different environments or API versions.

const { loadConfig } = require('graphql-config');

async function main() {
  const config = await loadConfig();
  const endpoint = config.getDefault().endpoint('default');
  console.log(endpoint);
}

main();

Other packages similar to graphql-config

graphql-tools

graphql-tools is a package that provides a set of utilities for building and working with GraphQL schemas. It is similar to graphql-config in that it helps with GraphQL development, but it focuses more on schema creation, mocking, and stitching, rather than configuration management.

apollo-server

apollo-server is a community-driven, open-source GraphQL server. It's similar to graphql-config in the sense that it's used in GraphQL development environments. However, apollo-server focuses on building and running GraphQL servers, including features like schema definition, data fetching, and request handling, rather than on project configuration.

README

GraphQL Config

The easiest way to configure your development environment with your GraphQL schema (supported by most tools, editors & IDEs).

• website: https://graphql-config.com

GraphQL Config file

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

Usage

Install:

  yarn add graphql-config
  npm install graphql-config

Use:

Very basic outline in TypeScript:

import {loadConfig} from 'graphql-config';

async function main() {
  const config = await loadConfig({...});

  const schema = await config.getDefault().getSchema();
}

The ... expression in the loadConfig function is a placeholder for a LoadConfigOptions object; leaving this space empty will pass defaults.

Here is a more robust, working example using a generate extension from the GraphQL CLI Backend Template:

const config = await loadConfig({
    extensions: [() => ({ name: 'generate'})]
});

const generateConfig = await config!.getDefault().extension('generate');

...
  
const schema = makeExecutableSchema({
    typeDefs,
    resolvers
});

Help & Community

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