Skip to content

Add typed JSON output to theme init - #8684

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 Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

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 #8673 September 28, 2026 09:53
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Sep 28, 2026
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review September 28, 2026 10:17
@gonzaloriestra
gonzaloriestra requested review from a team as code owners September 28, 2026 10:17
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 15928b5 to af38492 Compare September 28, 2026 11:39
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 9c90616 to a0861a7 Compare September 29, 2026 10:28
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 1742d91 to eced348 Compare September 29, 2026 13:44
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from 74e4949 to 2c8e408 Compare October 1, 2026 08:52
@gonzaloriestra
gonzaloriestra marked this pull request as draft October 6, 2026 12:18
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 707b96f to fb37427 Compare October 6, 2026 12:31
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 4aa8c29 to c2c97c3 Compare October 8, 2026 08:43
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from c2c97c3 to 9b21f3d Compare October 8, 2026 09:53
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 8, 2026 10:04
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from 39852ff to 2757cbd Compare October 9, 2026 12:26
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from 2757cbd to f8c3844 Compare October 9, 2026 12:48
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from f8c3844 to e4f59f1 Compare October 9, 2026 13:09
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch 2 times, most recently from ea75f3b to e2f278b Compare October 9, 2026 14:01
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-init branch from e2f278b to 4eb172b Compare October 9, 2026 14:11
@github-actions

github-actions Bot commented Oct 9, 2026

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-duplicate-json-contract.md '@shopify/cli': major
theme-info-json-contract.md '@shopify/cli': major
theme-list-json-contract.md '@shopify/cli': major
theme-open-json-contract.md '@shopify/cli': major
theme-preview-json-contract.md '@shopify/cli': major
theme-profile-environments.md '@shopify/cli': major
theme-push-json-contract.md "@shopify/cli": major

@github-actions

github-actions Bot commented Oct 9, 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;
packages/cli-kit/dist/public/node/themes/theme-manager.d.ts
@@ -11,5 +11,12 @@ export declare abstract class ThemeManager {
     findOrCreate(name?: string, role?: Role): Promise<Theme>;
     fetch(name?: string, role?: Role): Promise<Theme | undefined>;
     generateThemeName(context: string): string;
-    create(themeRole?: Role, themeName?: string): Promise<Theme>;
+    create(themeRole?: Role, themeName?: string): Promise<{
+        createdAtRuntime: boolean;
+        id: number;
+        name: string;
+        processing: boolean;
+        role: string;
+        src?: string;
+    }>;
 }
\ No newline at end of file

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