|
3186 | 3186 | "description": "Path to an environment file to override existing environment variables for the deployment.", |
3187 | 3187 | "isOptional": true |
3188 | 3188 | }, |
| 3189 | + { |
| 3190 | + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", |
| 3191 | + "syntaxKind": "PropertySignature", |
| 3192 | + "name": "--force-client-sourcemap", |
| 3193 | + "value": "\"\"", |
| 3194 | + "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", |
| 3195 | + "isOptional": true, |
| 3196 | + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" |
| 3197 | + }, |
3189 | 3198 | { |
3190 | 3199 | "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", |
3191 | 3200 | "syntaxKind": "PropertySignature", |
|
3274 | 3283 | "environmentValue": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN" |
3275 | 3284 | } |
3276 | 3285 | ], |
3277 | | - "value": "export interface hydrogendeploy {\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration <value>'?: string\n\n /**\n * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n *\n */\n '--build-command <value>'?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description <value>'?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user <value>'?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop <value>'?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token <value>'?: string\n}" |
| 3286 | + "value": "export interface hydrogendeploy {\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration <value>'?: string\n\n /**\n * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n *\n */\n '--build-command <value>'?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description <value>'?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user <value>'?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop <value>'?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token <value>'?: string\n}" |
3278 | 3287 | } |
3279 | 3288 | } |
3280 | 3289 | } |
|
3327 | 3336 | "description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.", |
3328 | 3337 | "isOptional": true |
3329 | 3338 | }, |
| 3339 | + { |
| 3340 | + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", |
| 3341 | + "syntaxKind": "PropertySignature", |
| 3342 | + "name": "--customer-account-push", |
| 3343 | + "value": "\"\"", |
| 3344 | + "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow", |
| 3345 | + "isOptional": true, |
| 3346 | + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH" |
| 3347 | + }, |
3330 | 3348 | { |
3331 | 3349 | "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", |
3332 | 3350 | "syntaxKind": "PropertySignature", |
|
3441 | 3459 | "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" |
3442 | 3460 | } |
3443 | 3461 | ], |
3444 | | - "value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path <value>'?: string\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port <value>'?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" |
| 3462 | + "value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path <value>'?: string\n\n /**\n * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n */\n '--customer-account-push'?: ''\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port <value>'?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" |
3445 | 3463 | } |
3446 | 3464 | } |
3447 | 3465 | } |
|
0 commit comments