Common utilities for graphql-config
Last updated 9 months ago by shopify-dep .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install graphql-config-utilities 
SYNC missed versions from official npm registry.


Common utilities for graphql-config


npm install graphql-config-utilities --save

or, with Yarn:

yarn add graphql-config-utilities



This utility reads schema information from a .graphqlconfig file in the project root. The configuration can contain one nameless project or many named projects. The configuration is compatible with the vscode-graphql extension. This extension provides syntax highlighting and autocomplete suggestions for graphql files.

Each project specifies a schemaPath, include, and exclude globs. Glob patterns match paths relative to the location of the configuration file. Omit exclude if empty.

See the official specification documentation for more detail and examples.

Example: single nameless project configuration

  "schemaPath": "build/schema.json",
  "includes": "app/**/*.graphql"

Example: multi-project configuration

  "projects": {
    "foo": {
      "schemaPath": "build/schema/foo.json",
      "includes": "app/foo/**/*.graphql"
    "bar": {
      "schemaPath": "build/schema/bar.json",
      "includes": "app/bar/**/*.graphql"

Example: YAML format

schemaPath: build/schema.json
  - 'app/**/*.graphql'

Current Tags

  • 1.0.0                                ...           latest (9 months ago)

1 Versions

  • 1.0.0                                ...           9 months ago
Maintainers (1)
Today 0
This Week 1
This Month 2
Last Day 1
Last Week 0
Last Month 4
Dependencies (1)
Dev Dependencies (0)

Copyright 2014 - 2016 © |