Skip to content

Add typed JSON output to theme open - #8639

Merged
gonzaloriestra merged 5 commits into
gonzalo/theme-telemetry-guardfrom
gonzalo/json-theme-open
Oct 15, 2026
Merged

gonzaloriestra merged 5 commits into
gonzalo/theme-telemetry-guardfrom
gonzalo/json-theme-open

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Theme links and identifiers need consistent JSON field names.

WHAT is this pull request doing?

Project strict theme resources with string IDs, camelCase links and nullable source URLs. Wait for browser opening before printing the final result, and retain explicit environment batches.

The public output follows docs/cli/json-output.md; explicitly named environments use one {environments: [...]} object.

How to manually test your changes?

shopify theme open --theme <theme-id> --store example.myshopify.com --json
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
  • 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

@github-actions github-actions Bot added shopify.dev preview Area: @shopify/cli @shopify/cli package issues labels Sep 24, 2026
@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
@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
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8655 September 25, 2026 12:28
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch 2 times, most recently from 51f0294 to f0db90b Compare September 28, 2026 10:25
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch from dcda62c to 7413939 Compare October 8, 2026 08:43
@gonzaloriestra gonzaloriestra reopened this Oct 8, 2026
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch from 7413939 to c1e8648 Compare October 8, 2026 09:53
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 8, 2026 10:03
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch 2 times, most recently from 517e2db to e5c44fd Compare October 9, 2026 12:26
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch from e5c44fd to dd3ac23 Compare October 9, 2026 12:48
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch 2 times, most recently from 27ddba7 to 65bbd04 Compare October 9, 2026 13:19

@karreiro karreiro 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.

Thank you, @gonzaloriestra!

@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-open branch from 65bbd04 to 1b7baea Compare October 14, 2026 08:08

@isaacroldan isaacroldan 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.

Found one regression in the cloud browser fallback.


🤖 Generated by the review-pr skill

Comment thread packages/theme/src/cli/commands/theme/open.ts Outdated
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Potential Breaking Changes Detected

This PR contains changes that may break the existing contract.

@shopify/dev_experience — this PR contains breaking changes that require coordination for the next major release.

📦 Major Version Changesets

The following changesets request a major version bump:

Changeset Package
theme-info-json-contract.md '@shopify/cli': major
theme-list-json-contract.md '@shopify/cli': major
theme-open-json-contract.md '@shopify/cli': major

@github-actions

Copy link
Copy Markdown
Contributor

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/base-command.d.ts
@@ -35,6 +35,7 @@ declare abstract class BaseCommand extends Command {
         argv: string[];
     }>;
     protected environmentsFilename(): string | undefined;
+    protected validateNonTTYFlags(flags: FlagOutput): void;
     protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
     private failMissingNonTTYFlagRequirements;
     private applicableNonTTYFlagRequirements;

@gonzaloriestra gonzaloriestra mentioned this pull request Oct 15, 2026
4 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/cli @shopify/cli package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants