Skip to content

Add typed JSON output to theme open - #8639

Open
gonzaloriestra wants to merge 1 commit into
gonzalo/json-theme-listfrom
gonzalo/json-theme-open
Open

gonzaloriestra wants to merge 1 commit into
gonzalo/json-theme-listfrom
gonzalo/json-theme-open

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

theme open only prints links for humans. Scripts need a typed, discoverable result containing the selected theme and its URLs.

Part of https://github.com/shop/issues-develop/issues/23695.

WHAT is this pull request doing?

Add --json and a domain-owned result schema. Keep theme selection, terminal text, and browser opening behavior unchanged, with separate execution and presentation.

Normal output:

Preview information for theme 'My theme' (#1)
• Preview your theme
• Customize your theme at the theme editor

JSON output:

{
  "theme": {
    "id": 1,
    "name": "My theme",
    "createdAtRuntime": false,
    "processing": false,
    "role": "unpublished"
  },
  "preview_url": "https://store.myshopify.com?preview_theme_id=1",
  "editor_url": "https://store.myshopify.com/admin/themes/1/editor"
}

The optional theme.src field is included when available. Refresh the command manifest, README, and generated documentation. Add service, schema, presentation, and real stdout/stderr tests.

How to manually test your changes?

pnpm shopify theme open --store YOUR_STORE --theme YOUR_THEME
pnpm shopify theme open --store YOUR_STORE --theme YOUR_THEME --editor
pnpm shopify theme open --store YOUR_STORE --theme YOUR_THEME --json
pnpm shopify theme open --help
pnpm shopify theme open --json-schema

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
  • A single changeset for all theme migrations is added in the last PR, #8643.

@github-actions github-actions Bot added shopify.dev preview Area: @shopify/cli @shopify/cli package issues labels Sep 24, 2026
@gonzaloriestra
gonzaloriestra added this pull request to stack #8646 September 24, 2026 09:23
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8646 September 24, 2026 10:04
@gonzaloriestra
gonzaloriestra changed the base branch from main to gonzalo/json-theme-list September 24, 2026 10:05
@gonzaloriestra
gonzaloriestra added this pull request to stack #8655 September 24, 2026 10:05
@github-actions github-actions Bot added no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. and removed Area: @shopify/cli @shopify/cli package issues labels Sep 24, 2026
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review September 24, 2026 14:13
@gonzaloriestra
gonzaloriestra requested review from a team as code owners September 24, 2026 14:13

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. shopify.dev preview

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant