Skip to content

Add typed JSON output to theme init - #8923

Open
gonzaloriestra wants to merge 6 commits into
gonzalo/json-theme-packagefrom
gonzalo/json-theme-init
Open

gonzaloriestra wants to merge 6 commits into
gonzalo/json-theme-packagefrom
gonzalo/json-theme-init

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Original PR and review history: #8684.

WHY are these changes introduced?

Fixes https://github.com/shop/issues-develop/issues/23694

Theme initialization needs structured outcomes that retain completed setup.

WHAT is this pull request doing?

Return an absolute project directory, instruction file paths and explicit success/partial outcomes. Keep a successfully cloned project when later AI setup fails, exit nonzero for partial work, and reject missing noninteractive names.

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

How to manually test your changes?

shopify theme init example-theme --json
shopify theme init --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

@gonzaloriestra
gonzaloriestra added this pull request to stack #8925 October 15, 2026 12:34
@github-actions github-actions Bot added shopify.dev preview no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. labels Oct 15, 2026
@gonzaloriestra gonzaloriestra changed the title gonzalo/json theme init Add typed JSON output to theme init Oct 15, 2026
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 15, 2026 12:42
@gonzaloriestra
gonzaloriestra requested review from a team as code owners October 15, 2026 12:42
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 2c94340 to c6f7d8c Compare October 15, 2026 13:52
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from c6f7d8c to 15a63a9 Compare October 15, 2026 14:10
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from f1fefea to f91b248 Compare October 15, 2026 15:11
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from f91b248 to f16a877 Compare October 15, 2026 16:13
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from f16a877 to 78f9f4b Compare October 16, 2026 08:15
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from 78f9f4b to 86a886e Compare October 16, 2026 08:40
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 54a8ff7 to 5a6e98f Compare October 16, 2026 11:08
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 397c2d4 to f9b20e4 Compare October 16, 2026 11:32

@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-init branch from f9b20e4 to 2241655 Compare October 16, 2026 14:20
@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-check-json-contract.md '@shopify/cli': major
theme-preview-json-contract.md '@shopify/cli': major
theme-profile-environments.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
@@ -21,6 +21,7 @@ declare abstract class BaseCommand extends Command {
     static descriptionWithoutMarkdown(): string | undefined;
     static analyticsNameOverride(): string | undefined;
     static analyticsStopCommand(): string | undefined;
+    private jsonOutputFromFlags;
     catch(error: Error & {
         skipOclifErrorHandling: boolean;
     }): Promise<void>;
@@ -36,6 +37,7 @@ declare abstract class BaseCommand extends Command {
     }, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(options?: Input<TFlags, TGlobalFlags, TArgs>, argv?: string[]): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
         argv: string[];
     }>;
+    protected runWithParsedOutput<T>(flags: FlagOutput, execute: () => T): T;
     protected environmentsFilename(): string | undefined;
     protected parseEnvironmentFlags<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(environment: JsonMap, options: Input<TFlags, TGlobalFlags, TArgs>, explicitFlags: FlagOutput): Promise<FlagOutput>;
     protected validateNonTTYFlags(flags: FlagOutput): void;

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.

3 participants