[Docs] Add examples for codgen for UI extensions and functions #1955
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+183
to
+194
| default: shopifyApiProject({ | ||
| apiType: ApiType.Storefront, | ||
| apiVersion: LATEST_API_VERSION, | ||
| documents: ["./extensions/**/*.{js,ts,jsx,tsx}", "./extensions/.server/**/*.{js,ts,jsx,tsx}"], | ||
| outputDir: "./extensions/types", | ||
| }), | ||
| UIExtensions: shopifyApiProject({ | ||
| apiType: ApiType.Admin, | ||
| apiVersion: LATEST_API_VERSION, | ||
| documents: ["./app/**/*.{js,ts,jsx,tsx}", "./app/.server/**/*.{js,ts,jsx,tsx}" ], | ||
| outputDir: "./app/types", | ||
| }), |
There was a problem hiding this comment.
I think you have swapped default and UIExtensions here.
| const config: IGraphQLConfig = { | ||
| projects: { | ||
| default: shopifyApiProject({ | ||
| apiType: ApiType.Storefront, |
There was a problem hiding this comment.
This may be me who is confused, but Function Extensions are these ones, right? If so, should be renamed to "... For Shopify Functions".
I don't think these has access to the Storefront API?
There was a problem hiding this comment.
So this example is for an app that is using the storefront API and Shopify Functions.
The code 229 to 239 is for Shopify Functions. I can clarify that with a comment.
There was a problem hiding this comment.
Put up a PR here to clarify.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Fixes #1081
WHAT is this pull request doing?
This PR adds example documentation for setting up a
.graphqlrc.tsfile for generating types for UI extensions as well as adding autocomplete for Shopify Functions extensions.Type of change
Checklist
pnpm changesetto create a draft changelog entry (do NOT update theCHANGELOG.mdfiles manually)