gulp-graphql

Keep your graphql schema up-to-date with gulp! Made for gulp 3

Features

• Attempts to generate a graphql schema from schema.js
• Can output both schema.json and schema.graphql

Installation

npm install gulp-graphql --save-dev

Usage

Example gulpfile.babel.js:

import gulp from 'gulp';
import schema from 'gulp-graphql';

gulp.task("schema", () => {
  console.log("Generating graphql schema...");

  return gulp.src("src/data/schema.js")
    .pipe(schema({
      json: true,
      graphql: false,
    }))
    .on('error', console.log)
    .pipe(gulp.dest("src/data"))
    .pipe(gulp.dest("dist/data"));
});

gulp.task('watch-schema', () => {
  gulp.watch("src/data/schema.js", [ 'schema' ]);
});

gulp.task("default", ["schema"]);

Options

• json (optional) (default: true)
  • Generate a graphql schema from your schema.js and output to schema.json
• graphql (optional) (default: true)
  • Output schema as a readable schema.graphql file
• fileName (optional) (default: schema)
  • Base name for your schema file, no extension
• indentation (optional) (default: 2)
  • Takes an Integer for indentation spaces of schema.json
• graphqlPath (optional)
  • Override for where to find graphql module.

Notes

Passing in graphql via init is a hack that I'm not thrilled about but seems to work.

Release log

0.2.0

• No longer needs to be initialized!
• Attempts to find modules graphql and graphql/utitlites on its own.

0.1.0

• Generates graphql schema.json and schema.graphql files w/ tests.

Licence

MIT License