node-gql-file-composer

🟢 NodeJS GraphQL Composer

A tiny and minimalist, with minimum dependencies tool, which allows you to use, split and organize the native GQL files in your NodeJs project.

---

How it works?

You can use native gql files in your nodejs/graphql project. You can split and organize it according to your needs. You can call it as you want, you can nest it as you need. Keep your gql files small and simple.

Example:

Using promise chain:

const express = require('express')
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');
const { composeSchema } = require('node-gql-file-composer')

const app = express()
composeSchema('./gql')
  .then(schema => {
    app.use('/graphql', graphqlHTTP({
      schema: buildSchema(schema),
      rootValue: { hello: () => { return 'Hello world!' }}
      graphiql: true,
    }))
  })
  .then(() => app
    .listen(4000, () => console.log('Now browse to localhost:4000/graphql')))

Using async/await syntax:

const express = require('express')
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');
const { composeSchema, dumpToFile, readFolder } = require('node-gql-file-composer')

const start = async function () {

  const app = express()
  const schema = await composeSchema('./gql')

  app.use('/graphql', graphqlHTTP({
    schema: buildSchema(schema),
    rootValue: { hello: () => { return 'Hello world!' }}
    graphiql: true,
  }))

  app.listen(4000, () => console.log('Now browse to localhost:4000/graphql'))
}


start()

Dump to the Schema File:

const express = require('express')
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');
const { composeSchema, dumpToFile } = require('node-gql-file-composer')

const start = async function () {

  const app = express()
  const schema = await composeSchema('./gql')

  app.use('/graphql', graphqlHTTP({
    schema: buildSchema(schema),
    rootValue: { hello: () => { return 'Hello world!' }}
    graphiql: true,
  }))

  app.listen(4000, () => console.log('Now browse to localhost:4000/graphql'))
}

dumpToFile('./gql')  // it will create a composed schema file in the root folder

start()

### Auto restart with `nodemon`:

You can the files extension to the nodemon and enjoy the auto-restarting behaviors on each change in gql files. Just add the following tweak to your script in the package.json file:

 "start": "nodemon --watch **/*.gql index.js"

and now your nodemon will also sensitive to the changes in your gql files:

❯ yarn start
yarn run v1.22.17
$ nodemon --watch **/*.gql index.js
[nodemon] 2.0.14
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): gql/index.gql
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node index.js`
Now browse to localhost:4000/graphql

[nodemon] restarting due to changes...
[nodemon] starting `node index.js`
[nodemon] restarting due to changes...
[nodemon] starting `node index.js`
Now browse to localhost:4000/graphql

Usage

The module provides 3 simple functions:

  function composeSchema( path ) {...}

  /*  async function which will compose on the fly all your chunks gql files
  *   into one schema used by graphql
  *   
  *   PARAMS: 
  *     < path:string > the place where you will have all your gql files/folders 
  */

  function dumpToFile( path, name ) {...}

  /*  a simple dump function which will compose all your chunks gql files
  *   into one schema and will write it into one single file in the root folder, according to the name, which is has a default *   name "schema"
  *   
  *   PARAMS: 
  *     < path:string > the place where you will have all your gql files/folders 
  *     < name:string | optional> the name of dump file ( default: "schema.gql")
  */

  function readFolder( path, name ) {...}

  /*  async internal function which will read and find all your .gql|.graphql files under provided path 
  */