Generate schema.graphql without running the server

[matthieudesprez]

I'm submitting a...

[ ] Regression 
[ ] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

schema.graphql is only generated when the serving is running

Expected behavior

it would be nice to have a way for generating the schema.graphql from command line

What is the motivation / use case for changing the behavior?

the current behavior causes troubles when merging branches which contain resolver modifications, we have to run the server to update the schema.graphql

[marcus-sa]

Take a look at https://graphql-code-generator.com :)

[matthieudesprez]

Thanks but graphql-code-generator generates code from graphql and I need the other way around.

Currently, my nest module looks like this:

@Module({
  imports: [
    GraphQLModule.forRoot({
      autoSchemaFile: join(process.cwd(), 'apps/api/src/graphql/schema.graphql'),
      installSubscriptionHandlers: true,
      tracing: true,
      debug: true
    }),
    ...other modules
  ]
})

With this, nestjs/graphql manages to pass all imported modules, containing their own resolvers, to type-graphql for generating a schema.graphql from the code, and that's what I would like to achieve through cli without having to run the entire application

[marcus-sa]

@matthieudesprez I think it would've been a good idea to mention that you're using type-graphql in the initial issue description.

[arekbal]

There is no need to de facto 'run' the server to generate schema file.
You only have to create an app and do .init() on it.

If you structurize your app properly - as in making separation between bootstrapping from starting the server then there is no issue.
In full scale app, one might need it (the clean separation) for e2e tests or 'dry' run anyway.

My guide: create a scripts folder next to src, put a script there, that would call init() from src/init.ts, and add this script invocation to package.json scripts.

There are also other approaches that might work like using DynamicModule for that.

[matthieudesprez]

@marcus-sa nest/graphql uses type-graphql to generate the schema.graphql

@arekbal thanks for your advice, the init() will do the trick

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.