Skip to content

Commit

Permalink
Update readme/manifest/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@isaacroldan
isaacroldan committed May 24, 2024
1 parent 11102d7 commit 0709794
Show file tree
Hide file tree
Showing 6 changed files with 209 additions and 18 deletions.
6 changes: 6 additions & 0 deletions docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,10 @@ export interface hydrogenbuild {
* @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP
*/
'--sourcemap'?: ''

/**
* Watches for changes and rebuilds the project writing output to disk.
* @environment SHOPIFY_HYDROGEN_FLAG_WATCH
*/
'--watch'?: ''
}
6 changes: 6 additions & 0 deletions docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
// This is an autogenerated file. Don't edit this file manually.
export interface hydrogendebugcpu {
/**
* Entry file for the worker. Defaults to `./server`.
* @environment SHOPIFY_HYDROGEN_FLAG_ENTRY
*/
'--entry <value>'?: string

/**
* Specify a path to generate the profile file. Defaults to "startup.cpuprofile".
*
Expand Down
30 changes: 30 additions & 0 deletions docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
// This is an autogenerated file. Don't edit this file manually.
export interface hydrogenpreview {
/**
* Builds the app before starting the preview server.
*
*/
'--build'?: ''

/**
* Automatically generates GraphQL types for your project’s Storefront API queries.
*
*/
'--codegen'?: ''

/**
* Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.
*
*/
'--codegen-config-path <value>'?: string

/**
* Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.
* @environment SHOPIFY_HYDROGEN_FLAG_DEBUG
*/
'--debug'?: ''

/**
* Entry file for the worker. Defaults to `./server`.
* @environment SHOPIFY_HYDROGEN_FLAG_ENTRY
*/
'--entry <value>'?: string

/**
* Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.
*
Expand Down Expand Up @@ -47,4 +71,10 @@ export interface hydrogenpreview {
* @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE
*/
'--verbose'?: ''

/**
* Watches for changes and rebuilds the project.
*
*/
'--watch'?: ''
}
65 changes: 62 additions & 3 deletions docs-shopify.dev/generated/generated_docs_data.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2163,9 +2163,18 @@
"description": "Controls whether sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.",
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--watch",
"value": "\"\"",
"description": "Watches for changes and rebuilds the project writing output to disk.",
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH"
}
],
"value": "export interface hydrogenbuild {\n /**\n * [Classic Remix Compiler] Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n *\n */\n '--bundle-stats'?: ''\n\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 * Disables any warnings about missing standard routes.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n */\n '--disable-route-warning'?: ''\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 * 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 * 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 * Controls whether sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n */\n '--sourcemap'?: ''\n}"
"value": "export interface hydrogenbuild {\n /**\n * [Classic Remix Compiler] Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n *\n */\n '--bundle-stats'?: ''\n\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 * Disables any warnings about missing standard routes.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n */\n '--disable-route-warning'?: ''\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 * 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 * 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 * Controls whether sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n */\n '--sourcemap'?: ''\n\n /**\n * Watches for changes and rebuilds the project writing output to disk.\n * @environment SHOPIFY_HYDROGEN_FLAG_WATCH\n */\n '--watch'?: ''\n}"
}
}
}
Expand Down Expand Up @@ -2390,6 +2399,15 @@
"name": "hydrogendebugcpu",
"description": "",
"members": [
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--entry <value>",
"value": "string",
"description": "Entry file for the worker. Defaults to `./server`.",
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
"syntaxKind": "PropertySignature",
Expand All @@ -2408,7 +2426,7 @@
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
}
],
"value": "export interface hydrogendebugcpu {\n /**\n * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n *\n */\n '--output <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}"
"value": "export interface hydrogendebugcpu {\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n *\n */\n '--output <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}"
}
}
}
Expand Down Expand Up @@ -3498,6 +3516,30 @@
"name": "hydrogenpreview",
"description": "",
"members": [
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--build",
"value": "\"\"",
"description": "Builds the app before starting the preview server.",
"isOptional": true
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--codegen",
"value": "\"\"",
"description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
"isOptional": true
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--codegen-config-path <value>",
"value": "string",
"description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
"isOptional": true
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
Expand All @@ -3507,6 +3549,15 @@
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--entry <value>",
"value": "string",
"description": "Entry file for the worker. Defaults to `./server`.",
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
Expand Down Expand Up @@ -3568,9 +3619,17 @@
"description": "Outputs more information about the command's execution.",
"isOptional": true,
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--watch",
"value": "\"\"",
"description": "Watches for changes and rebuilds the project.",
"isOptional": true
}
],
"value": "export interface hydrogenpreview {\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 * 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 * 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 * Runs the app in a Node.js sandbox instead of an Oxygen worker.\n * @environment SHOPIFY_HYDROGEN_FLAG_LEGACY_RUNTIME\n */\n '--legacy-runtime'?: ''\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}"
"value": "export interface hydrogenpreview {\n /**\n * Builds the app before starting the preview server.\n *\n */\n '--build'?: ''\n\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 * 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 * 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 * Runs the app in a Node.js sandbox instead of an Oxygen worker.\n * @environment SHOPIFY_HYDROGEN_FLAG_LEGACY_RUNTIME\n */\n '--legacy-runtime'?: ''\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\n /**\n * Watches for changes and rebuilds the project.\n *\n */\n '--watch'?: ''\n}"
}
}
}
Expand Down
39 changes: 24 additions & 15 deletions packages/cli/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ Builds a Hydrogen storefront for production.
```
USAGE
$ shopify hydrogen build [--bundle-stats] [--codegen-config-path <value> --codegen] [--disable-route-warning]
[--entry <value>] [--lockfile-check] [--path <value>] [--sourcemap]
[--entry <value>] [--lockfile-check] [--path <value>] [--sourcemap] [--watch]
FLAGS
--[no-]bundle-stats [Classic Remix Compiler] Show a bundle size summary after building. Defaults to true,
Expand All @@ -776,6 +776,7 @@ FLAGS
where the command is run.
--[no-]sourcemap Controls whether sourcemaps are generated. Default to `true`. Deactivate
`--no-sourcemaps`.
--watch Watches for changes and rebuilds the project writing output to disk.
DESCRIPTION
Builds a Hydrogen storefront for production.
Expand Down Expand Up @@ -849,9 +850,10 @@ Builds and profiles the server startup time the app.

```
USAGE
$ shopify hydrogen debug cpu [--output <value>] [--path <value>]
$ shopify hydrogen debug cpu [--entry <value>] [--output <value>] [--path <value>]
FLAGS
--entry=<value> Entry file for the worker. Defaults to `./server`.
--output=<value> [default: startup.cpuprofile] Specify a path to generate the profile file. Defaults to
"startup.cpuprofile".
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
Expand Down Expand Up @@ -1148,21 +1150,28 @@ Runs a Hydrogen storefront in an Oxygen worker for production.

```
USAGE
$ shopify hydrogen preview [--debug] [--env <value> | --env-branch <value>] [--inspector-port <value>]
[--legacy-runtime] [--path <value>] [--port <value>] [--verbose]
$ shopify hydrogen preview [--codegen-config-path <value> [--codegen --build]] [--debug] [--entry <value> ] [--env
<value> | --env-branch <value>] [--inspector-port <value>] [--legacy-runtime] [--path <value>] [--port <value>]
[--verbose] [--watch ]
FLAGS
--debug Enables inspector connections to the server with a debugger such as Visual Studio Code or
Chrome DevTools.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle using
the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch name.
--inspector-port=<value> The port where the inspector is available. Defaults to 9229.
--legacy-runtime Runs the app in a Node.js sandbox instead of an Oxygen worker.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--port=<value> The port to run the server on. Defaults to 3000.
--verbose Outputs more information about the command's execution.
--build Builds the app before starting the preview server.
--codegen Automatically generates GraphQL types for your project’s Storefront API queries.
--codegen-config-path=<value> Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if
this file exists.
--debug Enables inspector connections to the server with a debugger such as Visual Studio Code
or Chrome DevTools.
--entry=<value> Entry file for the worker. Defaults to `./server`.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle
using the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch name.
--inspector-port=<value> The port where the inspector is available. Defaults to 9229.
--legacy-runtime Runs the app in a Node.js sandbox instead of an Oxygen worker.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--port=<value> The port to run the server on. Defaults to 3000.
--verbose Outputs more information about the command's execution.
--watch Watches for changes and rebuilds the project.
DESCRIPTION
Runs a Hydrogen storefront in an Oxygen worker for production.
Expand Down
Loading

0 comments on commit 0709794

Please sign in to comment.