Skip to content

Commit

Permalink
Improved language around --nodelete flag in push and pull commands
Browse files Browse the repository at this point in the history
This commit updates the language around the --nodelete flag in the push and pull commands
to make it more clear what files are being affected by the flag.
  • Loading branch information
EvilGenius13 committed Oct 18, 2024
1 parent c350201 commit 58768c3
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .changeset/wicked-years-smash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/cli': patch
---

Improve language around --nodelete flags for push and pull commands
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface themepull {
'--no-color'?: ''

/**
* Runs the pull command without deleting local files.
* Prevent deleting local files that don't exist remotely.
* @environment SHOPIFY_FLAG_NODELETE
*/
'-n, --nodelete'?: ''
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface themepush {
'--no-color'?: ''

/**
* Runs the push command without deleting local files.
* Prevent deleting remote files that don't exist locally.
* @environment SHOPIFY_FLAG_NODELETE
*/
'-n, --nodelete'?: ''
Expand Down
8 changes: 4 additions & 4 deletions docs-shopify.dev/generated/generated_docs_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -5714,7 +5714,7 @@
"syntaxKind": "PropertySignature",
"name": "-n, --nodelete",
"value": "\"\"",
"description": "Runs the pull command without deleting local files.",
"description": "Prevent deleting local files that don't exist remotely.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_NODELETE"
},
Expand Down Expand Up @@ -5755,7 +5755,7 @@
"environmentValue": "SHOPIFY_FLAG_IGNORE"
}
],
"value": "export interface themepull {\n /**\n * Pull theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * Pull theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Runs the pull command without deleting local files.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\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 * 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 * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
"value": "export interface themepull {\n /**\n * Pull theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * Pull theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting local files that don't exist remotely.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\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 * 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 * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
}
}
}
Expand Down Expand Up @@ -5878,7 +5878,7 @@
"syntaxKind": "PropertySignature",
"name": "-n, --nodelete",
"value": "\"\"",
"description": "Runs the push command without deleting local files.",
"description": "Prevent deleting remote files that don't exist locally.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_NODELETE"
},
Expand Down Expand Up @@ -5937,7 +5937,7 @@
"environmentValue": "SHOPIFY_FLAG_IGNORE"
}
],
"value": "export interface themepush {\n /**\n * Allow push to a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Push theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * Output JSON instead of a UI.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Push theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Runs the push command without deleting local files.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\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 * Publish as the live theme after uploading.\n * @environment SHOPIFY_FLAG_PUBLISH\n */\n '-p, --publish'?: ''\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 * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Create a new unpublished theme and push to it.\n * @environment SHOPIFY_FLAG_UNPUBLISHED\n */\n '-u, --unpublished'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
"value": "export interface themepush {\n /**\n * Allow push to a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Push theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment <value>'?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore <value>'?: string\n\n /**\n * Output JSON instead of a UI.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Push theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting remote files that don't exist locally.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed).\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only <value>'?: string\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 * Publish as the live theme after uploading.\n * @environment SHOPIFY_FLAG_PUBLISH\n */\n '-p, --publish'?: ''\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 * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme <value>'?: string\n\n /**\n * Create a new unpublished theme and push to it.\n * @environment SHOPIFY_FLAG_UNPUBLISHED\n */\n '-u, --unpublished'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2076,7 +2076,7 @@ FLAGS
-d, --development Pull theme files from your remote development theme.
-e, --environment=<value> The environment to apply to the current command.
-l, --live Pull theme files from your remote live theme.
-n, --nodelete Runs the pull command without deleting local files.
-n, --nodelete Prevent deleting local files that don't exist remotely.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
Expand Down Expand Up @@ -2110,7 +2110,7 @@ FLAGS
-e, --environment=<value> The environment to apply to the current command.
-j, --json Output JSON instead of a UI.
-l, --live Push theme files from your remote live theme.
-n, --nodelete Runs the push command without deleting local files.
-n, --nodelete Prevent deleting remote files that don't exist locally.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-p, --publish Publish as the live theme after uploading.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5687,7 +5687,7 @@
"nodelete": {
"allowNo": false,
"char": "n",
"description": "Runs the pull command without deleting local files.",
"description": "Prevent deleting local files that don't exist remotely.",
"env": "SHOPIFY_FLAG_NODELETE",
"name": "nodelete",
"type": "boolean"
Expand Down Expand Up @@ -5856,7 +5856,7 @@
"nodelete": {
"allowNo": false,
"char": "n",
"description": "Runs the push command without deleting local files.",
"description": "Prevent deleting remote files that don't exist locally.",
"env": "SHOPIFY_FLAG_NODELETE",
"name": "nodelete",
"type": "boolean"
Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/cli/commands/theme/pull.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If no theme is specified, then you're prompted to select the theme to pull from
}),
nodelete: Flags.boolean({
char: 'n',
description: 'Runs the pull command without deleting local files.',
description: `Prevent deleting local files that don't exist remotely.`,
env: 'SHOPIFY_FLAG_NODELETE',
}),
only: Flags.string({
Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/cli/commands/theme/push.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export default class Push extends ThemeCommand {
}),
nodelete: Flags.boolean({
char: 'n',
description: 'Runs the push command without deleting local files.',
description: `Prevent deleting remote files that don't exist locally.`,
env: 'SHOPIFY_FLAG_NODELETE',
}),
only: Flags.string({
Expand Down

0 comments on commit 58768c3

Please sign in to comment.