get-schema has no consistent order of properties

[cloudlena]

Every time I run graphql get-schema, the values of enums and the parameters of queries and mutations are sorted differently in schema.graphql. This leads to unnecessary changes in git diff when checking in the schema.graphql file. Shouldn't the order of enum values and query/mutation params be alphabetical and therefore consistent?

[schickling]

Good point. Would actually be interesting what should be the source of truth here. The server? A certain strategy in the GraphQL CLI?

[cloudlena]

That is a good point you're making, @schickling! I just checked using GraphiQL and there the params and enums are also not in alphabetical order. So maybe it's the server who messes the order up every time... I'm using https://github.com/graphql-go/handler. Do you think I should create the issue there instead?

[kbrandwijk]

I think we should strive to reduce diffs to a minimum. That being said, maybe we should aim for a server-independent standard for local schema storage. Alphabetical makes sense, Schema - Query - Mutation - Subscription - Interfaces - Unions - Types - Input Types - Enums, then alphabetical also makes sense.

[cloudlena]

I just created graphql-go/handler#34 to order the properties coming from the Go library.

[Urigo]

We've just released a new alpha version channel for GraphQL CLI - 4.0.0-alpha.XXX!

We've changed the get-schema command to use GraphQL Code Generator plugin of GraphQL CLI with the Codegen's schema-ast plugin.

And for the diff we use GraphQL Inspector now.

Those tools should provide you with consistent output between runs.

Checkout new instructions in the migration guide and let us know your feedback during that alpha period!

Feel free to contact us by opening a new issue or joining our Discord channel;
https://discord.gg/xud7bH

[Urigo]

I've posted the wrong Discord link, this is the correct one: https://discord.gg/xud7bH9