sibelius / graphql2ts Goto Github PK

View Code? Open in Web Editor NEW

41.0 3.0 2.0 1.28 MB

Transform .graphql to graphql-js typescript

JavaScript 8.82% TypeScript 91.18%

graphql codemod ast code-first

graphql2ts's Introduction

graphql2ts

Transform .graphql files to graphql-js typescript code

History

We first had graphql-js implementation, but developers weren't happy with it. So it was born schema first with graphql-tools, merge-graphql-schemas, graphql-modules.

There is also a codemod to transform your .js files to .graphql files: jscodeshift-graphql-files.

After a lot of time, schema first showed some scaling problems, Schema First Problems, mostly because it does not colocate schema with resolvers, and code is much more powerful to implement abstraction on top of it.

This codemod exists to helps us move back to code first approach (graphql-js and related tools).

It will transform a .graphql file and transform in a graphql-js .ts declartion

How to run

npx graphql2ts myschema.graphql mySchemaOutput.ts

How to test

yarn jest

graphql2ts's People

Contributors

Stargazers

Watchers

Forkers

washingtonsoares zaguiini

graphql2ts's Issues

handle all ast kind nodes

Invoke the classes on generated code

Currently the generated code doesn't prepend the new keyword on each graphql-js type:

Look at the GraphQLNonNull over there

Make possible to specify a prettier configuration

Currently we are using "stock" prettier to create the TS file, but it would be better to allow a custom configuration that matches user preferences.

create a cli

handle relay like mutation generation code

add tests

add example

handle graphql primitives

Int -> GraphQLInt
Float -> GraphQLFloat
...

improve README

Import dependencies on code generation

Currently the generated code doesn't import any dependencies. Here's what it generates:

One possible solution would be to include a configuration file to specify which package to include the dependencies. Something like graphql2ts.config.js or a command-line argument like --package which could be omitted since we are using the graphql-js package.

Unable to run the CLI

What I tried to do

npx graphql2ts schema.graphql schema.ts

What I expected

To have the TS schema

What happened

Cannot find module '../lib/cli.js'
Require stack:
- /Users/zaguini/.npm/_npx/1599/lib/node_modules/graphql2ts/bin/cli

Further research

It looks like the transpiled code has not been shipped:

This screenshot above is directly from the path specified above on the stack trace.

I tried to run the build process locally cloning the repository but it failed, maybe that's why. Here's what happened:

> rm -rf lib/* && babel src --extensions ".es6,.js,.es,.jsx,.mjs,.ts,.tsx" --ignore __test__,__testfixtures__,*.spec.ts --out-dir lib

Error: Cannot find module '@babel/plugin-proposal-nullish-coalescing-operator' from '/Users/zaguini/Development/graphql2ts'

There's already a PR in place (#9) that fixes this bug.