@graphql-tools/webpack-loader

A set of utils for faster development of GraphQL tools

Usage no npm install needed!

<script type="module">
  import graphqlToolsWebpackLoader from 'https://cdn.skypack.dev/@graphql-tools/webpack-loader';
</script>

README

GraphQL Tools Webpack Loader

A webpack loader to preprocess GraphQL Documents (operations, fragments and SDL)

Slightly different fork of graphql-tag/loader.

yarn add @graphql-tools/webpack-loader

How is it different from graphql-tag? It removes locations entirely, doesn't include sources (string content of imported files), no warnings about duplicated fragment names and supports more custom scenarios.

Options

  • noDescription (default: false) - removes descriptions
  • esModule (default: false) - uses import and export statements instead of CommonJS

Importing GraphQL files

To add support for importing .graphql/.gql files, see Webpack loading and preprocessing below.

Given a file MyQuery.graphql

query MyQuery {
  ...
}

If you have configured the webpack @graphql-tools/webpack-loader, you can import modules containing graphQL queries. The imported value will be the pre-built AST.

import MyQuery from './query.graphql'

Preprocessing queries and fragments

Preprocessing GraphQL queries and fragments into ASTs at build time can greatly improve load times.

Webpack loading and preprocessing

Using the included @graphql-tools/webpack-loader it is possible to maintain query logic that is separate from the rest of your application logic. With the loader configured, imported graphQL files will be converted to AST during the webpack build process.

{
  loaders: [
    {
      test: /\.(graphql|gql)$/,
      exclude: /node_modules/,
      loader: '@graphql-tools/webpack-loader',
      options: {
        /* ... */
      }
    }
  ],
}