Skip to content

Add typed JSON output to theme list - #8641

Open
gonzaloriestra wants to merge 1 commit into
donald/theme-info-json-schemafrom
gonzalo/json-theme-list
Open

gonzaloriestra wants to merge 1 commit into
donald/theme-info-json-schemafrom
gonzalo/json-theme-list

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

theme list --json has an existing result shape but no discoverable schema.

Related to shop/issues-develop#23691. Stacked on #8525.

WHAT is this pull request doing?

Return typed theme data and expose its schema. Keep the existing single-environment JSON and table output. Multiple environments emit one {environments: [{environment, result}]} document in requested order; failed environments report errors on stderr and are omitted, with existing exit behavior preserved.

Normal output:

name    role    id
Dawn    [live]  #1

Matching JSON:

[{"id":1,"name":"Dawn","processing":false,"createdAtRuntime":false,"role":"live"}]

Adds the opt-in result collection boundary in ThemeCommand, with results recorded after analytics cleanup. Refreshes generated help and the manifest.

How to manually test your changes?

shopify theme list --store example.myshopify.com
shopify theme list --store example.myshopify.com --json
shopify theme list --json-schema
shopify theme list --environment development --environment staging --json

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, #8682.

@gonzaloriestra
gonzaloriestra added this pull request to stack #8644 September 24, 2026 09:19
@github-actions github-actions Bot added the Area: @shopify/cli @shopify/cli package issues label Sep 24, 2026
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8644 September 24, 2026 10:04
@gonzaloriestra
gonzaloriestra added this pull request to stack #8655 September 24, 2026 10:05
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-list branch 2 times, most recently from 479bc56 to bfe48a7 Compare September 24, 2026 10:25
@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 force-pushed the gonzalo/json-theme-list branch 2 times, most recently from 1ced35d to fb8ea3a Compare September 25, 2026 12:28
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8655 September 25, 2026 12:28
@gonzaloriestra
gonzaloriestra added this pull request to stack #8673 September 25, 2026 12:29
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-list branch 2 times, most recently from 964ae97 to 69e125b Compare September 28, 2026 10:25
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-list branch 2 times, most recently from 49c6245 to 696f8e2 Compare September 29, 2026 10:28
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-list branch 2 times, most recently from 05a956c to aa4252a Compare September 29, 2026 14:18
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-list branch from c2de27e to a9efff4 Compare October 1, 2026 08:52
@github-actions

github-actions Bot commented Oct 1, 2026

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;

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant