Add typed JSON output to doc search

[isaacroldan]

WHY are these changes introduced?

doc search prints the search response but has no JSON flag or discoverable result contract. This PR is stacked on the doc fetch change.

WHAT is this pull request doing?

Add --json and schema discovery for documentation matches. JSON mode returns a named results collection and records unknown pagination metadata. Preserve the raw response in default mode, including successful responses that do not match the JSON schema; JSON mode reports those responses through the standard fatal-error path.

The examples show the same response excerpt. Other matches and the remaining chunk content are omitted.

Default output:

[
  {
    "score": 0.8255787,
    "content": "Manage webhook subscriptions",
    "url": "https://shopify.dev/docs/apps/build/webhooks/subscribe",
    "title": "Manage webhook subscriptions",
    "domain": "webhooks"
  }
]

JSON output:

{
  "results": [
    {
      "score": 0.8255787,
      "content": "Manage webhook subscriptions",
      "url": "https://shopify.dev/docs/apps/build/webhooks/subscribe",
      "title": "Manage webhook subscriptions",
      "domain": "webhooks"
    }
  ],
  "pageInfo": {
    "hasNextPage": null
  }
}

Validation: 73 documentation tests, build, type-check, lint, and Knip pass. Live command checks and adversarial review cover result projection, raw-response bytes, schema discovery, output channels, and failure exits.

How to manually test your changes?

pnpm shopify doc search --query "subscribe to webhooks"
pnpm shopify doc search --query "subscribe to webhooks" --json
pnpm shopify doc search --query "products" --api-name admin --api-version invalid --json
pnpm shopify doc search --json-schema

Compare the raw response with the typed JSON object. The invalid API version should return one error document and a nonzero exit code.

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
• Added a minor changeset for the new JSON flag.

[isaacroldan]

/snapit

[isaacroldan]

/snapit

[github-actions]

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 498fdad6965b6263fe6a1aee0fe880420b6e3be5. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261006142201

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.