[Improvement] User experience of the GraphQL client generation tool

[RolandHewage]

Description:

Different solutions were discussed to improve the user experience of the GraphQL client generation tool as summarized here. Based on the research and discussions held with higher level managers it was,

• [x] Agreed to add a new template tag graphql-client for the new Ballerina project creation command to generate prototypes necessary for the GraphQL client generation tool.

  bal new <package_name> -t graphql-client

• [x] Agreed to provide the 3rd party GraphQL Foundation VS Code plugin as an extension recommendation in the .vscode file of the project. Users will be recommended with a pop up to install the GraphQL plugin as a prerequisite for GraphQL query validation and execution in VS Code.

• [x] Suggested to provide the configurable options for GraphQL client generation tool as comments in the generated prototypes, so that the user can enable them based on their usage. Suggested to add proper references.

• Suggested to implement a compile time validator as a future improvement to validate the changes in the GraphQL queries and the generated client code.

• Discussed about the necessity to improve the Ballerina project creation command with additional template tags to support configuration of GraphQL API URL etc. The support for these options will be considered during future improvements of the command.

Related Tasks:

• [x] https://github.com/ballerina-platform/graphql-tools/issues/46
• [x] https://github.com/ballerina-platform/graphql-tools/issues/48
• [x] https://github.com/ballerina-platform/ballerina-library/issues/6450
• https://github.com/ballerina-platform/ballerina-library/issues/6449

[RolandHewage]

The compile plugin for the validating the generated clients using GraphQL client tool is de-prioritized. This will be addressed in the future.