镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Add typed JSON output to app function info - #8755

Merged
gonzaloriestra merged 3 commits into
mainfrom
gonzalo/function-info-json
Oct 16, 2026
Merged

gonzaloriestra merged 3 commits into
mainfrom
gonzalo/function-info-json

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Related to https://github.com/shop/issues-develop/issues/23666

WHY are these changes introduced?

app function info --json has no discoverable schema and exposes targeting as a keyed object with omitted missing fields.

WHAT is this pull request doing?

Return a typed function resource with a targets array, absolute native paths, and null for unavailable fields. Keep human-readable sections in the presenter. This changes the existing JSON contract and includes a major changeset.

Normal output (excerpt):

CONFIGURATION
Handle       my-function
Name         My Function
API Version  2024-01

Matching JSON:

{
  "function": {
    "handle": "my-function",
    "name": "My Function",
    "apiVersion": "2024-01",
    "directory": "/app/extensions/my-function",
    "targets": [],
    "schemaPath": "/app/extensions/my-function/schema.graphql",
    "wasmPath": "/app/extensions/my-function/dist/index.wasm",
    "functionRunnerPath": "/cli/function-runner"
  }
}

How to manually test your changes?

shopify app function info --path /path/to/function
shopify app function info --path /path/to/function --json
shopify app function info --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 — added a major changeset for the existing JSON contract

Stack

  1. Add typed JSON output to app function info #8755 — Function info
  2. Add typed JSON output to app function run #8756 — Function run
  3. Add typed JSON output to app function replay #8757 — Function replay

@gonzaloriestra

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

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

Built from beeb27861be67399e08856d26f5fc15aafd883f2. 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-20261005124840

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.

@gonzaloriestra
gonzaloriestra added this pull request to stack #8773 October 6, 2026 08:00
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/function-info-json branch 4 times, most recently from 65d493f to f9af47f Compare October 13, 2026 14:32
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 14, 2026 11:11
@gonzaloriestra
gonzaloriestra requested review from a team as code owners October 14, 2026 11:11
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/function-info-json branch from f9af47f to 119577b Compare October 14, 2026 11:12

@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 issue with configured paths.


🤖 Generated by the review-pr skill

Comment thread packages/app/src/cli/services/function/info.ts Outdated
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/function-info-json branch from 119577b to 5229989 Compare October 15, 2026 09:45
@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
function-info-json-contract.md '@shopify/cli': major

@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Oct 16, 2026
Merged via the queue into main with commit 623a9e0 Oct 16, 2026
27 of 30 checks passed
@gonzaloriestra
gonzaloriestra deleted the gonzalo/function-info-json branch October 16, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/cli @shopify/cli package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants