gql

Tools for working with GraphQL documents

Warning: these tools are still in an early phase and there will be issues. Bug reports and pull-requests are welcome!

Table of Contents

• Background
• Install
  • Packages
• Contribute
• License

Background

Building GraphQL schemas in the GraphQL native language (i.e. .graphql files) has several benefits over using a programming language:

• Your data structures are language agnostic so only the resolvers need to be programmed.
• The GraphQL language is terser than most programming languages. Schemas are simpler to write and understand.
• Schemas rarely change after compile time; most people won't take advantage of progammatic schemas.
• Schemas can be accessed without a GraphQL server.

Hopefully the tools in this repository make it easier to work with GraphQL files.

Install

The quickest way to get started is by globally installing the gql command-line interface:

$ npm i -g gql-cli

Packages

Package	Description	Version	Dependencies
gql-cli	Command-line interface for gql GraphQL tools
gql-format	Tools for formatting GraphQL documents
gql-merge	Tools for merging GraphQL documents
gql-lint	Tools for linting GraphQL documents

Contribute

Feel free to dive in! Open an issue or submit PRs.

gql follows the Contributor Covenant Code of Conduct.

License

MIT (c) Liam Curry