Skip to content

Hide deprecated remix template from app init help text (shop/issues-develop#21581)#7405

Merged
isaacroldan merged 1 commit into
mainfrom
04-27-hide_deprecated_remix_template_from_app_init
Apr 28, 2026
Merged

Hide deprecated remix template from app init help text (shop/issues-develop#21581)#7405
isaacroldan merged 1 commit into
mainfrom
04-27-hide_deprecated_remix_template_from_app_init

Conversation

@isaacroldan

@isaacroldan isaacroldan commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Fixes shop/issues-develop#21581

shopify app init --template <invalid> still listed remix in its help text and in the validation error, even though the remix template was removed from the interactive picker in favor of React Router. Users running into the error were nudged toward a deprecated option.

WHAT is this pull request doing?

  • packages/app/src/cli/prompts/init/init.ts: set templates.remix.visible = false, matching the existing pattern for node and ruby (still accepted via --template for back-compat, but no longer advertised in help text, validation errors, or generated docs).
  • Added two unit tests asserting visibleTemplates excludes remix and equals ['reactRouter', 'none'].
  • Regenerated the artefacts that make refresh-manifests / refresh-readme / build-dev-docs produce: packages/cli/oclif.manifest.json, packages/create-app/oclif.manifest.json, packages/cli/README.md, docs-shopify.dev/commands/interfaces/app-init.interface.ts, and the two generated_docs_data*.json files.
  • Patch changeset for @shopify/app.

How to test your changes?

  1. From this branch, run:
    shopify app init --template not_a_real_template
    
  2. Expect the validation error to list only reactRouter and none — no remix.
  3. Confirm shopify app init --template remix still works (back-compat preserved).

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

…evelop#21581)

The `remix` template was still listed in the `--template` help text and validation
error message even though it was removed from the interactive `shopify app init`
menu in favor of React Router. Mark `remix` as `visible: false` (matching the
existing pattern for `node` and `ruby`) so it is no longer advertised, while
keeping it as a valid alias for backwards compatibility.
Copilot AI review requested due to automatic review settings April 27, 2026 13:20
@isaacroldan isaacroldan requested review from a team as code owners April 27, 2026 13:20

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR hides the deprecated remix app template from shopify app init --template help/Docs output while preserving backward compatibility for --template remix.

Changes:

  • Mark the remix predefined template as not visible, so it’s omitted from help text and validation messaging.
  • Update generated oclif manifests, CLI README command docs, and docs-shopify.dev generated docs to remove remix from the advertised --template aliases.
  • Add a small unit test to ensure visibleTemplates excludes remix and only exposes the currently offered aliases.

Reviewed changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/create-app/oclif.manifest.json Updates init --template flag description to no longer advertise remix.
packages/cli/oclif.manifest.json Updates app init --template flag description to no longer advertise remix.
packages/cli/README.md Updates rendered command docs for shopify app init to remove remix from the advertised aliases.
packages/app/src/cli/prompts/init/init.ts Marks remix template as visible: false and exports visibleTemplates derived from template visibility.
packages/app/src/cli/prompts/init/init.test.ts Adds coverage asserting visibleTemplates excludes remix and equals ['reactRouter','none'].
docs-shopify.dev/generated/generated_docs_data_v2.json Updates generated docs text for --template to remove remix from advertised aliases.
docs-shopify.dev/generated/generated_docs_data.json Updates generated docs text for --template to remove remix from advertised aliases.
docs-shopify.dev/commands/interfaces/app-init.interface.ts Updates autogenerated interface docs for --template to remove remix from advertised aliases.
.changeset/hide-deprecated-remix-template.md Adds a patch changeset describing the user-facing change and back-compat behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@isaacroldan isaacroldan added this pull request to the merge queue Apr 28, 2026
Merged via the queue into main with commit 362ccfa Apr 28, 2026
32 checks passed
@isaacroldan isaacroldan deleted the 04-27-hide_deprecated_remix_template_from_app_init branch April 28, 2026 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants