liamcurry / gql Goto Github PK

Tools for working with GraphQL documents

License: MIT License

JavaScript 100.00%

gql's Introduction

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!

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

gql's People

Contributors

Stargazers

Watchers

Forkers

empia mr-beerkiss lyxsus justinanastos amannn beauvankirk coralproject synchronized-tv oanillar

gql's Issues

Update gql-merge multiple inheritance syntax

Hi, I'm using gql-merge and when trying to run it against a schema which has multiple inheritance via the updated syntax I'm getting an error:

> ./node_modules/gql-merge/dist/index.js -v -o ./src/appsync/schema.graphql ./src/appsync/graphql/**/*.graphql

(node:83712) UnhandledPromiseRejectionWarning: GraphQLError: Syntax Error GraphQL (2:35) Cannot parse the unexpected character "&".

1: 
2: type CreativeWork implements Node & Output {
                                     ^
3:   id: ID!

    at syntaxError (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/error/syntaxError.js:28:15)
    at readToken (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/lexer.js:247:32)
    at Object.advanceLexer [as advance] (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/lexer.js:46:28)
    at expect (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:963:11)
    at parseName (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:88:15)
    at parseNamedType (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:577:11)
    at parseImplementsInterfaces (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:702:18)
    at parseObjectTypeDefinition (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:681:20)
    at parseTypeSystemDefinition (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:607:16)
    at parseDefinition (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:148:16)
    at parseDocument (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:106:22)
    at parse (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/graphql/language/parser.js:43:10)
    at mergeString (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/gql-merge/dist/index.js:263:39)
    at mergeStrings (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/gql-merge/dist/index.js:254:10)
    at _callee$ (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/gql-merge/dist/index.js:45:46)
    at tryCatch (/Users/xxxxxx/Sites/aaah/xxxxxx/node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:62:40)
(node:83712) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:83712) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

graphql/graphql-js#1169

Remove Babel-runtime dependency or have a package.json specifying it as a dependency

The way you packaged this makes little sense to me. I am trying to use the programmatic API in typescript to merge GQL schemas at runtime. I get the error Cannot find module 'babel-runtime/core-js/promise' because of the way you have this bundled in your dist. To make it even more confusing, you've removed the src from npm, so I can't reference the source that shouldn't have that dependency.

This just seems like an incredibly non-standard way to package things.

Build error

I'm doing this

import {mergeStrings} from 'gql-merge';

import authenticationTypeDef from './authentication/typeDefs';
import entitesTypeDef from './entities/typeDefs';
const mergedTypeDefs = mergeStrings([
    authenticationTypeDef,
    entitesTypeDef
]);

and I get the error Error: Cannot find module 'babel-runtime/core-js/promise', so I guess that the logic of the module is attached to the one of the cli as mentioned in #4

PS: in #3 he had the same problem, but there's no further documentation of the process

preserve comments

Not sure if it is a big deal, but I wouldn't mind if we could preserve those comments that are used to generate the descriptions in graphiql.

Thanks
J;

Separate the CLI logic from the LIB logic.

I'm importing mergeFileGlob function into my app code, which is then being built by webpack. But then when I run my code, the CLI logic is running. This is incredibly inconvenient, as it causes my application to quit. Please fix this.

merge does not understand "extend" word

Hello.
I have few schema files loading by server:
------- 1.graphql ---------------
type Query {
}
------ 2.graphql ---------------
type User {
id: ID!
}
extend type Query {
getUser(userId: ID!) : User
}
------ 3.graphql ---------------
type Category {
id: ID!
}
extend type Query {
getCategory(userId: ID!, categoryId: ID!) : Category
}

The problem is that "gql" tool "merge" option does not understand word "extend" that is a legal
word for graphql schema syntax.