Skip to content

Commit f7ac007

Browse files
committed
Update path flag language to be more generic
While for almost all commands a theme folder is required that's not necessarily true for some of them. Instead of modifying the flag description for some of the commands we can generalize the description in a way that explains exactly what it's doing while covering both scenarios. Users will get a warning that the command is not being run in a theme directory anyways.
1 parent 02b417b commit f7ac007

20 files changed

+82
-82
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface themecheck {
5252
'-o, --output <value>'?: string
5353

5454
/**
55-
* The path to your theme directory.
55+
* The path where you want to run the command. Defaults to the current working directory.
5656
* @environment SHOPIFY_FLAG_PATH
5757
*/
5858
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export interface themeconsole {
1919
'--password <value>'?: string
2020

2121
/**
22-
* The path to your theme directory.
22+
* The path where you want to run the command. Defaults to the current working directory.
2323
* @environment SHOPIFY_FLAG_PATH
2424
*/
2525
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface themedelete {
3131
'--password <value>'?: string
3232

3333
/**
34-
* The path to your theme directory.
34+
* The path where you want to run the command. Defaults to the current working directory.
3535
* @environment SHOPIFY_FLAG_PATH
3636
*/
3737
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export interface themedev {
7373
'--password <value>'?: string
7474

7575
/**
76-
* The path to your theme directory.
76+
* The path where you want to run the command. Defaults to the current working directory.
7777
* @environment SHOPIFY_FLAG_PATH
7878
*/
7979
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface themeinfo {
3131
'--password <value>'?: string
3232

3333
/**
34-
* The path to your theme directory.
34+
* The path where you want to run the command. Defaults to the current working directory.
3535
* @environment SHOPIFY_FLAG_PATH
3636
*/
3737
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export interface themeinit {
1919
'--no-color'?: ''
2020

2121
/**
22-
* The path to your theme directory.
22+
* The path where you want to run the command. Defaults to the current working directory.
2323
* @environment SHOPIFY_FLAG_PATH
2424
*/
2525
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface themelist {
3737
'--password <value>'?: string
3838

3939
/**
40-
* The path to your theme directory.
40+
* The path where you want to run the command. Defaults to the current working directory.
4141
* @environment SHOPIFY_FLAG_PATH
4242
*/
4343
'--path <value>'?: string

docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export interface thememetafieldspull {
1919
'--password <value>'?: string
2020

2121
/**
22-
* The path to your theme directory.
22+
* The path where you want to run the command. Defaults to the current working directory.
2323
* @environment SHOPIFY_FLAG_PATH
2424
*/
2525
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface themeopen {
3737
'--password <value>'?: string
3838

3939
/**
40-
* The path to your theme directory.
40+
* The path where you want to run the command. Defaults to the current working directory.
4141
* @environment SHOPIFY_FLAG_PATH
4242
*/
4343
'--path <value>'?: string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export interface themepackage {
77
'--no-color'?: ''
88

99
/**
10-
* The path to your theme directory.
10+
* The path where you want to run the command. Defaults to the current working directory.
1111
* @environment SHOPIFY_FLAG_PATH
1212
*/
1313
'--path <value>'?: string

0 commit comments

Comments
 (0)