Skip to content

Add typed JSON output to theme check - #8920

Merged
gonzaloriestra merged 9 commits into
mainfrom
gonzalo/json-theme-check
Oct 19, 2026
Merged

gonzaloriestra merged 9 commits into
mainfrom
gonzalo/json-theme-check

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Original PR and review history: #8642.

WHY are these changes introduced?

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

Theme Check JSON needs consistent validation results and diagnostic fields.

WHAT is this pull request doing?

Return valid, flat issues and consistent severity counts with absolute file paths and zero-based camelCase positions. Retain completed validation in environment batches, honor the blocking policy, and wait for requested corrections before final JSON.

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

How to manually test your changes?

shopify theme check --path . --json
shopify theme check --path . --output=json
shopify theme check --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 Area: @shopify/cli @shopify/cli package issues labels Oct 15, 2026
@gonzaloriestra gonzaloriestra changed the title gonzalo/json theme check Add typed JSON output to theme check 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-check branch from cbc61f4 to 5fc194f Compare October 15, 2026 13:33
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch from 5fc194f to f5fe261 Compare October 15, 2026 13:52
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch 3 times, most recently from 39313b0 to 9f5d761 Compare October 15, 2026 15:11

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

JSON mode still misses two supported input paths.


🤖 Generated by the review-pr skill

Comment thread packages/theme/src/cli/commands/theme/check.ts Outdated
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch 3 times, most recently from bb63927 to 7ce8bcb Compare October 16, 2026 08:40

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

Found one remaining diagnostic issue.


🤖 Generated by the review-pr skill

Comment thread packages/theme/src/cli/services/check.ts Outdated
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch from 7ce8bcb to b5ca8ae Compare October 16, 2026 10:37
Comment thread packages/cli-kit/src/public/node/base-command.ts
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch 3 times, most recently from 477b1ed to 582384c Compare October 16, 2026 14:20

@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-check branch from 582384c to bb0e289 Compare October 19, 2026 08:44
@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Oct 19, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 19, 2026
Base automatically changed from gonzalo/json-theme-preview to main October 19, 2026 11:02
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-check branch from bb0e289 to f4263d1 Compare October 19, 2026 11:02
@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

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

@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Oct 19, 2026
Merged via the queue into main with commit 7264721 Oct 19, 2026
28 of 31 checks passed
@gonzaloriestra
gonzaloriestra deleted the gonzalo/json-theme-check branch October 19, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants