Support flexible templates for app init
#6751
Open
+809
−155
Conversation
This file contains hidden or 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
This comment has been minimized.
This comment has been minimized.
Contributor
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3611 tests passing in 1423 suites. Report generated by 🧪jest coverage report action from 770bb28 |
Contributor
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code |
shauns
force-pushed
the
shauns/01-09-support_flexible_templates_for_app_init_
branch
from
5599003 to
770bb28
Compare
gonzaloriestra
approved these changes
Jan 12, 2026
Contributor
gonzaloriestra
left a comment
gonzaloriestra
left a comment
There was a problem hiding this comment.
I'm approving because we need it for the next release and it works. But all the loading code was already too confusing and this is adding more complexity... So I hope we can simplify later.
I have this draft PR to remove the legacy schema by adding a client_id to the templates. Maybe we could support this as well without adding a new schema.
| * Uses passthrough() to allow any extra keys from full-featured templates | ||
| * (e.g., metafields, metaobjects, webhooks) without strict validation. | ||
| */ | ||
| export const TemplateConfigSchema = zod |
Contributor
There was a problem hiding this comment.
I see more differences with LegacyAppSchema besides the passthrough (like extension_directories). Is that ok?
| return { | ||
| isLaunchable, | ||
| scopesArray: getAppScopesArray(config), | ||
| scopesArray: getTemplateScopesArray(config), |
Contributor
There was a problem hiding this comment.
Why adding a new function instead of updating the existing one?
| const isLaunchable = webs.webs.some((web) => isWebType(web, WebType.Frontend) || isWebType(web, WebType.Backend)) | ||
| // Use permissive schema to allow templates with extra configuration (metafields, metaobjects, etc.) | ||
| const config = await parseConfigurationFile(TemplateConfigSchema, configurationPath) | ||
| const webs = await loadWebsForAppCreation(appDirectory, config.web_directories) |
Contributor
There was a problem hiding this comment.
Why can't we use the regular loadWebs?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 an issue where app templates using certain module types cause
app initto fail. The issue is due to the app template using module types that aren't defined within the CLI, but more generally due toapp initvalidating/understanding app configuration.WHAT is this pull request doing?
Instead, we process app config during app instantiation as opaque blobs -- we don't rely on being able to validate them or a particular structure being in place.
In
app initthe app is loaded twice -- once as a template, and then again as the local copy of the app is linked to the remote version of it.How to test your changes?
Locally:
pnpm shopify app init --path="<where I keep my apps>" --template="https://github.com/Shopify/shopify-app-template-react-router#include-declarative-definition"Measuring impact
How do we know this change was effective? Please choose one:
Checklist