Skip to content

Prepare Hydrogen commands for typed JSON output #4095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gonzaloriestra wants to merge 1 commit into from
Draft

Prepare Hydrogen commands for typed JSON output #4095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"@qwik.dev/partytown": "^0.11.2",
"@react-router/dev": "7.16.0",
"@react-router/fs-routes": "7.16.0",
"@shopify/cli": "3.93.2",
"@shopify/cli": "0.0.0-nightly-20260928062710",

@fredericoo fredericoo Sep 29, 2026

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.

question: root @shopify/cli is on the 0928 nightly while CLI Kit is on 0929. The description explains why (the matching CLI nightly wasn't published), but since the local launcher reaches into CLI Kit's private schema module with the CLI's config, shall we line these up again when the stable release lands?

"@shopify/eslint-plugin-cli": "4.0.0",
"@shopify/prettier-config": "catalog:",
"@total-typescript/ts-reset": "^0.6.1",
Expand Down
188 changes: 186 additions & 2 deletions packages/cli/oclif.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
"args": {},
"description": "Builds a Hydrogen storefront for production.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -112,6 +119,13 @@
},
"description": "Returns diagnostic information about a Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -143,6 +157,13 @@
"args": {},
"description": "Generate types for the Storefront API queries found in your project.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -197,6 +218,13 @@
"args": {},
"description": "Push project configuration to admin",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -263,6 +291,13 @@
"args": {},
"description": "Builds and profiles the server startup time the app.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -312,6 +347,13 @@
"args": {},
"description": "Builds and deploys a Hydrogen storefront to Oxygen.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"entry": {
"description": "Entry file for the worker. Defaults to `./server`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ENTRY",
Expand Down Expand Up @@ -526,6 +568,13 @@
"args": {},
"description": "Runs Hydrogen storefront in an Oxygen worker for development.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -682,6 +731,13 @@
"args": {},
"description": "List the environments on your linked Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -714,6 +770,13 @@
"args": {},
"description": "Populate your .env with variables from your Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
Expand Down Expand Up @@ -785,6 +848,13 @@
"args": {},
"description": "Push environment variables from the local .env file to your linked Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
Expand Down Expand Up @@ -852,7 +922,15 @@
"aliases": [],
"args": {},
"description": "Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.",
"flags": {},
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [],
Expand Down Expand Up @@ -895,6 +973,13 @@
},
"description": "Generates a standard Shopify route.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"adapter": {
"description": "React Router adapter used in the route. The default is `react-router`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
Expand Down Expand Up @@ -958,6 +1043,13 @@
"args": {},
"description": "Generates all supported standard shopify routes.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"adapter": {
"description": "React Router adapter used in the route. The default is `react-router`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
Expand Down Expand Up @@ -1020,6 +1112,13 @@
"args": {},
"description": "Creates a new Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
Expand Down Expand Up @@ -1140,6 +1239,13 @@
"args": {},
"description": "Link a local project to one of your shop's Hydrogen storefronts.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
Expand Down Expand Up @@ -1221,6 +1327,13 @@
"args": {},
"description": "Returns a list of Hydrogen storefronts available on a given shop.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1252,6 +1365,13 @@
"args": {},
"description": "Login to your Shopify account.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1292,6 +1412,13 @@
"args": {},
"description": "Logout of your local session.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1323,6 +1450,13 @@
"args": {},
"description": "Runs a Hydrogen storefront in an Oxygen worker for production.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1463,6 +1597,13 @@
"args": {},
"description": "Scaffold routes and core functionality.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1534,6 +1675,13 @@
},
"description": "Setup CSS strategies for your project.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1591,6 +1739,13 @@
},
"description": "Setup support for multiple markets in your project.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1623,6 +1778,13 @@
"args": {},
"description": "EXPERIMENTAL: Upgrades the project to use Vite.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1653,7 +1815,15 @@
"aliases": [],
"args": {},
"description": "Creates a global `h2` shortcut for the Hydrogen CLI",
"flags": {},
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:shortcut",
Expand All @@ -1676,6 +1846,13 @@
"args": {},
"description": "Unlink a local project from a Hydrogen storefront.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down Expand Up @@ -1707,6 +1884,13 @@
"args": {},
"description": "Upgrade Remix and Hydrogen npm dependencies.",
"flags": {
"json-schema": {
"description": "Print the command's JSON schemas.",
"env": "SHOPIFY_FLAG_JSON_SCHEMA",
"name": "json-schema",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
},
"dependencies": {
"@ast-grep/napi": "0.34.1",
"@oclif/core": "3.26.5",
"@shopify/cli-kit": "^3.80.4",
"@oclif/core": "4.8.3",
"@shopify/cli-kit": "0.0.0-nightly-20260929144221",
"@shopify/oxygen-cli": "4.6.18",
"@shopify/plugin-cloudflare": "^3.78.1",
"ansi-escapes": "^6.2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/commands/hydrogen/codegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Command from '@shopify/cli-kit/node/base-command';
import {renderSuccess} from '@shopify/cli-kit/node/ui';
import {renderSuccess} from '../../lib/ui.js';
import colors from '@shopify/cli-kit/node/colors';
import {resolvePath} from '@shopify/cli-kit/node/path';
import {Flags} from '@oclif/core';
Expand Down
Loading
Loading