Repository navigation
Add JSON schema for theme info - #8909
Merged
Merged
Conversation
Assisted-By: devx/9dd3b67e-58e9-4a01-a721-43265d02ccd2
Assisted-By: devx/9dd3b67e-58e9-4a01-a721-43265d02ccd2
Assisted-By: devx/b173c0b4-2d65-4396-a5eb-d3c4d4c3a4ff
Assisted-By: devx/0033c079-2574-4c3b-a8f1-d9a752834d90
Assisted-By: devx/1fb42754-a68b-4733-9ea3-74521b5da069
Assisted-By: devx/8b520d2e-bc34-4a3d-b5fa-748b2fff362e
gonzaloriestra
added this pull request to stack #8925
October 15, 2026 12:34
gonzaloriestra
marked this pull request as ready for review
October 15, 2026 12:42
gonzaloriestra
force-pushed
the
donald/theme-info-json-schema
branch
from
October 15, 2026 13:33
52862bf to
80b2dd5
Compare
Contributor
|
| Changeset | Package |
|---|---|
theme-info-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@@ -1,4 +1,5 @@
import { type JsonOutputSchema } from './json-output-schema.js';
+import { JsonMap } from '../../private/common/json.js';
import { Command } from '@oclif/core';
import { OutputFlags, Input, ParserOutput, FlagInput, OutputArgs } from '@oclif/core/parser';
export type ArgOutput = OutputArgs<any>;
@@ -35,6 +36,8 @@ declare abstract class BaseCommand extends Command {
argv: string[];
}>;
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;
protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
private failMissingNonTTYFlagRequirements;
private applicableNonTTYFlagRequirements;
|
isaacroldan
approved these changes
Oct 15, 2026
karreiro
approved these changes
Oct 15, 2026
karreiro
left a comment
Contributor
There was a problem hiding this comment.
Thank you, @gonzaloriestra!
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.
Original PR and review history: #8525.
WHY are these changes introduced?
Fixes https://github.com/shop/issues-develop/issues/23691
Theme and environment JSON results should have a discoverable, consistent contract.
WHAT is this pull request doing?
Expose strict camelCase resources, string theme IDs, nullable unavailable fields and one ordered object for explicit environment batches. Preserve authentication and operation failures per environment.
The public output follows
docs/cli/json-output.md; explicitly named environments use one{environments: [...]}object.How to manually test your changes?
Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add