Add codegen option for excludes

[bannzai]

Abstract

Add property ofexcludes option to ApolloCodegenOptions.
ref: https://github.com/apollographql/apollo-tooling#apollo-clientcodegen-output

Why

I need this option.

In my case, My app use multiple GraphQL API endpoint(More detailed, we use the Shopify Storefront API and our own server's API).
Therefore, it is necessary to know between the schema file and the endpoint correspondence.
My approach is to make a difference in naming the schema file. Like Shopify Storefront API schema file name to *.storefront.graphql, our server API schema file name to *.graphql.
This approach and executing codegen two times with correct codegen option can be enable to separate generation code for each schema correspond to endpoint.

But, our server's API case has problem. Because specifying*.grpahql include *.storefront.graphql. So, I got error when codegen.
I need exclude option.

note: I tried glob negative formula, but for some reason it didn't seem to work.(Like *!(.storefront).graphql and [!.storefront].graphql ...etc)

Question

How to update ApolloCodegenOptions.md? Manually?

[calvincestari]

Hi @bannzai - thanks for PR.

I need this option.

@bannzai could you describe your use case a bit more please.

[AnthonyMDev]

How to update ApolloCodegenOptions.md? Manually?

You just need to run the DocumentationGenerator in the SwiftScripts project. We can do that when we make an actual release including this.

But definitely a good addition to add this. @bannzai have you tested that this works with your code?

[bannzai]

@bannzai could you describe your use case a bit more please.

I added more details :)

[bannzai]

But definitely a good addition to add this. @bannzai have you tested that this works with your code?

Yes, I already test and it's looks good to me 👍

[bannzai]

You just need to run the DocumentationGenerator in the SwiftScripts project. We can do that when we make an actual release including this.

Thank you for your response . I will try it!

[calvincestari]

It's probably better not to include the documentation change in this PR since doc updates are published immediately and the codegen parameter change will only be 'published' in the next release. That's why we usually update docs at release.

[calvincestari]

My approach is to make a difference in naming the schema file. Like Shopify Storefront API schema file name to *.storefront.graphql, our server API schema file name to *.graphql.
This approach and executing codegen two times with correct codegen option can be enable to separate generation code for each schema correspond to endpoint.

But, our server's API case has problem. Because specifying*.grpahql include *.storefront.graphql. So, I got error when codegen.
I need exclude option.

Thanks for the detail. I'm not against exposing exclude since the underlying tool supports it but you could achieve what you want already by using subdirectories for Shopify vs. Server files instead of one common directory. Then the include parameter would change between codegen executions.

Shopify/**/*.graphql
Server/**/*.graphql

[bannzai]

It's probably better not to include the documentation change in this PR since doc updates are published immediately and the codegen parameter change will only be 'published' in the next release. That's why we usually update docs at release.

I see. OK, I will not execute DocumentationGenerator

[bannzai]

but you could achieve what you want already by using subdirectories for Shopify vs. Server files instead of one common directory. Then the include parameter would change between codegen executions.

Thank you for the useful advice 👍 But in my case is not resolved...
In my project architecture, the rule is to put the .graphql file and the .swift file that uses it in the same directory.
It becomes clearly which View is using which Query, Mutation, Fragment ...etc. I'm sure the project structure will continue to change in the future, so I hope that include this PR to apollo-ios!

[calvincestari]

In my project architecture, the rule is to put the .graphql file and the .swift file that uses it in the same directory.

Could that work if you changed the output directory between the two code generation executions too?

You might be pleased to know then that in the upcoming 1.0 release (Alpha 2 is the current latest) the code generator will have an option to co-locate the .swift file with the .graphql operation file. So you could put them anywhere in your project. It also only supports multiple files so you won't end up with one single massive API.swift file anymore. 🎉

[calvincestari]

@bannzai withholding the doc updates it looks like this PR is complete and ready to merge; code change + updated test. Is there anything else you wanted to add here?

[bannzai]

You might be pleased to know then that in the upcoming 1.0 release (Alpha 2 is the current latest) the code generator will have an option to co-locate the .swift file with the .graphql operation file. So you could put them anywhere in your project. It also only supports multiple files so you won't end up with one single massive API.swift file anymore. 🎉

That's cool! I really can't wait!

@bannzai withholding the doc updates it looks like this PR is complete and ready to merge; code change + updated test. Is there anything else you wanted to add here?

No further updates anymore. This PR is completed and ready to merge 👍 Thank you!