Repository navigation
Add typed JSON output to theme package - #8683
Open
gonzaloriestra wants to merge 5 commits into
Open
gonzaloriestra wants to merge 5 commits into
gonzaloriestra wants to merge 5 commits into
Conversation
gonzaloriestra
added this pull request to stack #8673
September 28, 2026 09:53
gonzaloriestra
marked this pull request as ready for review
September 28, 2026 09:57
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
September 28, 2026 10:25
9dce70c to
cbf4e74
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
September 28, 2026 11:39
cbf4e74 to
8290b55
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
September 28, 2026 11:52
8290b55 to
195f2b0
Compare
isaacroldan
reviewed
Sep 29, 2026
| vi.mock('@shopify/cli-kit/node/analytics', () => ({ | ||
| recordEvent: vi.fn(), | ||
| compileData: vi.fn().mockReturnValue({timings: {}, errors: {}, retries: {}, events: {}}), | ||
| })) |
Contributor
There was a problem hiding this comment.
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
Contributor
Author
There was a problem hiding this comment.
Updated, thanks
isaacroldan
approved these changes
Sep 29, 2026
isaacroldan
left a comment
Contributor
There was a problem hiding this comment.
Minor comment on the tests
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
September 29, 2026 10:28
195f2b0 to
28d575f
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
September 29, 2026 11:11
28d575f to
29801b7
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
2 times, most recently
from
September 29, 2026 13:44
5f102b2 to
72d4123
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
3 times, most recently
from
October 1, 2026 08:52
901c0bc to
d5ad578
Compare
gonzaloriestra
marked this pull request as draft
October 6, 2026 12:18
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 6, 2026 12:29
d5ad578 to
f62547a
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 8, 2026 08:27
d4c96a7 to
7fd0bc6
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 8, 2026 08:43
7fd0bc6 to
515529c
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 8, 2026 09:53
515529c to
b8db95e
Compare
gonzaloriestra
marked this pull request as ready for review
October 8, 2026 10:04
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
2 times, most recently
from
October 9, 2026 12:26
cf702b0 to
3034081
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 9, 2026 12:48
3034081 to
9aa6e95
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
2 times, most recently
from
October 9, 2026 13:19
9b568c8 to
86c3847
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 9, 2026 14:01
86c3847 to
68b94cf
Compare
gonzaloriestra
force-pushed
the
gonzalo/json-theme-package
branch
from
October 9, 2026 14:11
68b94cf to
0169d92
Compare
Contributor
|
| 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 |
Contributor
Differences in type declarationsWe 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:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Packaging needs a machine-readable artifact receipt.
WHAT is this pull request doing?
Return a strict JSON artifact result with a validated absolute path to the ZIP actually written, while preserving the text presenter.
The public output follows
docs/cli/json-output.md; explicitly named environments use one{environments: [...]}object.How to manually test your changes?
shopify theme package --path . --json shopify theme package --json-schemaChecklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add