Skip to content

Commit fca9c19

Browse files
jamesmengojamesmengo
committed
Changeset + docs
1 parent 1761d5e commit fca9c19

File tree

5 files changed

+61
-4
lines changed

5 files changed

+61
-4
lines changed

‎.changeset/bright-impalas-float.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@shopify/theme': minor
3+
---
4+
5+
Render error overlay when `theme dev` encounters asset upload errors

‎docs-shopify.dev/commands/interfaces/theme-dev.interface.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ export interface themedev {
66
*/
77
'-e, --environment <value>'?: string
88

9+
/**
10+
* Controls the visibility of the error overlay when an theme asset upload fails:
11+
- silent Prevents the error overlay from appearing.
12+
- default Displays the error overlay.
13+
14+
* @environment SHOPIFY_FLAG_ERROR_OVERLAY
15+
*/
16+
'--error-overlay <value>'?: string
17+
918
/**
1019
* Set which network interface the web server listens on. The default value is 127.0.0.1.
1120
* @environment SHOPIFY_FLAG_HOST

‎docs-shopify.dev/generated/generated_docs_data.json‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4960,6 +4960,15 @@
49604960
"name": "themedev",
49614961
"description": "",
49624962
"members": [
4963+
{
4964+
"filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
4965+
"syntaxKind": "PropertySignature",
4966+
"name": "--error-overlay <value>",
4967+
"value": "string",
4968+
"description": "Controls the visibility of the error overlay when an theme asset upload fails: - silent Prevents the error overlay from appearing. - default Displays the error overlay.",
4969+
"isOptional": true,
4970+
"environmentValue": "SHOPIFY_FLAG_ERROR_OVERLAY"
4971+
},
49634972
{
49644973
"filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
49654974
"syntaxKind": "PropertySignature",
@@ -5114,7 +5123,7 @@
51145123
"environmentValue": "SHOPIFY_FLAG_IGNORE"
51155124
}
51165125
],
5117-
"value": "export interface themedev {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Set which network interface the web server listens on. The default value is 127.0.0.1.\n * @environment SHOPIFY_FLAG_HOST\n */\n '--host <value>'?: string\n\n /**\n * Skip hot reloading any files that match the specified pattern.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload\n * @environment SHOPIFY_FLAG_LIVE_RELOAD\n */\n '--live-reload <value>'?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify <value>'?: string\n\n /**\n * Hot reload only files that match the specified pattern.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Password generated from the Theme Access app.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password <value>'?: string\n\n /**\n * The path to your theme directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Local port to serve theme preview from.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store <value>'?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password <value>'?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Synchronize Theme Editor updates in the local theme files.\n * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n */\n '--theme-editor-sync'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
5126+
"value": "export interface themedev {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n \n * @environment SHOPIFY_FLAG_ERROR_OVERLAY\n */\n '--error-overlay <value>'?: string\n\n /**\n * Set which network interface the web server listens on. The default value is 127.0.0.1.\n * @environment SHOPIFY_FLAG_HOST\n */\n '--host <value>'?: string\n\n /**\n * Skip hot reloading any files that match the specified pattern.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload\n * @environment SHOPIFY_FLAG_LIVE_RELOAD\n */\n '--live-reload <value>'?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify <value>'?: string\n\n /**\n * Hot reload only files that match the specified pattern.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Password generated from the Theme Access app.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password <value>'?: string\n\n /**\n * The path to your theme directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Local port to serve theme preview from.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store <value>'?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password <value>'?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Synchronize Theme Editor updates in the local theme files.\n * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n */\n '--theme-editor-sync'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
51185127
}
51195128
}
51205129
}

‎packages/cli/README.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1796,9 +1796,10 @@ Uploads the current theme as a development theme to the connected store, then pr
17961796

17971797
```
17981798
USAGE
1799-
$ shopify theme dev [-e <value>] [--host <value>] [-x <value>] [--live-reload hot-reload|full-page|off]
1800-
[--no-color] [-n] [--notify <value>] [-o <value>] [--open] [--password <value>] [--path <value>] [--port <value>]
1801-
[-s <value>] [--store-password <value>] [-t <value>] [--theme-editor-sync] [--verbose]
1799+
$ shopify theme dev [-e <value>] [--error-overlay silent|default] [--host <value>] [-x <value>]
1800+
[--live-reload hot-reload|full-page|off] [--no-color] [-n] [--notify <value>] [-o <value>] [--open] [--password
1801+
<value>] [--path <value>] [--port <value>] [-s <value>] [--store-password <value>] [-t <value>]
1802+
[--theme-editor-sync] [--verbose]
18021803
18031804
FLAGS
18041805
-e, --environment=<value>
@@ -1821,6 +1822,13 @@ FLAGS
18211822
-x, --ignore=<value>...
18221823
Skip hot reloading any files that match the specified pattern.
18231824
1825+
--error-overlay=<option>
1826+
[default: default] Controls the visibility of the error overlay when an theme asset upload fails:
1827+
- silent Prevents the error overlay from appearing.
1828+
- default Displays the error overlay.
1829+
1830+
<options: silent|default>
1831+
18241832
--host=<value>
18251833
Set which network interface the web server listens on. The default value is 127.0.0.1.
18261834

‎packages/cli/oclif.manifest.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5123,6 +5123,19 @@
51235123
"name": "environment",
51245124
"type": "option"
51255125
},
5126+
"error-overlay": {
5127+
"default": "default",
5128+
"description": "Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n ",
5129+
"env": "SHOPIFY_FLAG_ERROR_OVERLAY",
5130+
"hasDynamicHelp": false,
5131+
"multiple": false,
5132+
"name": "error-overlay",
5133+
"options": [
5134+
"silent",
5135+
"default"
5136+
],
5137+
"type": "option"
5138+
},
51265139
"force": {
51275140
"allowNo": false,
51285141
"char": "f",
@@ -6398,6 +6411,19 @@
63986411
"name": "environment",
63996412
"type": "option"
64006413
},
6414+
"error-overlay": {
6415+
"default": "default",
6416+
"description": "Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n ",
6417+
"env": "SHOPIFY_FLAG_ERROR_OVERLAY",
6418+
"hasDynamicHelp": false,
6419+
"multiple": false,
6420+
"name": "error-overlay",
6421+
"options": [
6422+
"silent",
6423+
"default"
6424+
],
6425+
"type": "option"
6426+
},
64016427
"force": {
64026428
"allowNo": false,
64036429
"char": "f",

0 commit comments

Comments
 (0)