Skip to content

Add typed JSON output to theme package - #8683

Open
gonzaloriestra wants to merge 1 commit into
gonzalo/json-theme-profilefrom
gonzalo/json-theme-package
Open

gonzaloriestra wants to merge 1 commit into
gonzalo/json-theme-profilefrom
gonzalo/json-theme-package

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

theme package creates a ZIP file but has no machine-readable result or discoverable output schema.

Part of shop/issues-develop#23694.

WHAT is this pull request doing?

Return the ZIP path from packaging and present it as text or validated JSON. Keep the existing archive contents, filename rules, errors, and success message.

Normal output:

Your local theme was packaged in Dawn-1.0.zip

Matching JSON example:

{"path": "/themes/example/Dawn-1.0.zip"}

How to manually test your changes?

pnpm shopify theme package --path YOUR_THEME
pnpm shopify theme package --path YOUR_THEME --json
pnpm shopify theme package --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, #8682.

@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 Sep 28, 2026
@gonzaloriestra
gonzaloriestra added this pull request to stack #8673 September 28, 2026 09:53
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review September 28, 2026 09:57
@gonzaloriestra
gonzaloriestra requested review from a team as code owners September 28, 2026 09:57
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from 9dce70c to cbf4e74 Compare September 28, 2026 10:25
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from cbf4e74 to 8290b55 Compare September 28, 2026 11:39
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from 8290b55 to 195f2b0 Compare September 28, 2026 11:52
vi.mock('@shopify/cli-kit/node/analytics', () => ({
recordEvent: vi.fn(),
compileData: vi.fn().mockReturnValue({timings: {}, errors: {}, retries: {}, events: {}}),
}))

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.

you don't need these special cases no? Just

vi.mock('@shopify/cli-kit/node/ui')
vi.mock('@shopify/cli-kit/node/analytics')

Should work fine

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, thanks

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

Minor comment on the tests

@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from 195f2b0 to 28d575f Compare September 29, 2026 10:28
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from 28d575f to 29801b7 Compare September 29, 2026 11:11
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch 2 times, most recently from 5f102b2 to 72d4123 Compare September 29, 2026 13:44
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch 2 times, most recently from 3d1d2b9 to 901c0bc Compare September 29, 2026 14:40
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-package branch from 901c0bc to d5ad578 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. shopify.dev preview

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants