Skip to content

Commit 799b462

Browse files
committed
hiding flag because it is internal
1 parent 58585e0 commit 799b462

File tree

5 files changed

+16
-30
lines changed

5 files changed

+16
-30
lines changed

docs-shopify.dev/commands/interfaces/app-function-run.interface.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ export interface appfunctionrun {
2424
*/
2525
'-i, --input <value>'?: string
2626

27-
/**
28-
* The client that invoked this command.
29-
* @environment SHOPIFY_FLAG_INVOKED_BY
30-
*/
31-
'-b, --invoked-by <value>'?: string
32-
3327
/**
3428
* Output the result as JSON.
3529
* @environment SHOPIFY_FLAG_JSON

docs-shopify.dev/generated/generated_docs_data.json

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,15 +1292,6 @@
12921292
"isOptional": true,
12931293
"environmentValue": "SHOPIFY_FLAG_VERBOSE"
12941294
},
1295-
{
1296-
"filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
1297-
"syntaxKind": "PropertySignature",
1298-
"name": "-b, --invoked-by <value>",
1299-
"value": "string",
1300-
"description": "The client that invoked this command.",
1301-
"isOptional": true,
1302-
"environmentValue": "SHOPIFY_FLAG_INVOKED_BY"
1303-
},
13041295
{
13051296
"filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
13061297
"syntaxKind": "PropertySignature",
@@ -1338,7 +1329,7 @@
13381329
"environmentValue": "SHOPIFY_FLAG_JSON"
13391330
}
13401331
],
1341-
"value": "export interface appfunctionrun {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id <value>'?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config <value>'?: string\n\n /**\n * Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n */\n '-e, --export <value>'?: string\n\n /**\n * The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n */\n '-i, --input <value>'?: string\n\n /**\n * The client that invoked this command.\n * @environment SHOPIFY_FLAG_INVOKED_BY\n */\n '-b, --invoked-by <value>'?: string\n\n /**\n * Output the result as JSON.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
1332+
"value": "export interface appfunctionrun {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id <value>'?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config <value>'?: string\n\n /**\n * Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n */\n '-e, --export <value>'?: string\n\n /**\n * The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n */\n '-i, --input <value>'?: string\n\n /**\n * Output the result as JSON.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
13421333
}
13431334
}
13441335
}

packages/app/src/cli/commands/app/function/run.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ export default class FunctionRun extends AppUnlinkedCommand {
3535
}),
3636
'invoked-by': Flags.string({
3737
char: 'b',
38+
hidden: true,
3839
description: 'The client that invoked this command.',
3940
env: 'SHOPIFY_FLAG_INVOKED_BY',
4041
}),

packages/cli/README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -414,20 +414,19 @@ Run a function locally for testing.
414414

415415
```
416416
USAGE
417-
$ shopify app function run [--client-id <value> | -c <value>] [-e <value>] [-i <value>] [-b <value>] [-j]
418-
[--no-color] [--path <value>] [--reset | ] [--verbose]
419-
420-
FLAGS
421-
-b, --invoked-by=<value> The client that invoked this command.
422-
-c, --config=<value> The name of the app configuration.
423-
-e, --export=<value> Name of the WebAssembly export to invoke.
424-
-i, --input=<value> The input JSON to pass to the function. If omitted, standard input is used.
425-
-j, --json Output the result as JSON.
426-
--client-id=<value> The Client ID of your app.
427-
--no-color Disable color output.
428-
--path=<value> The path to your function directory.
429-
--reset Reset all your settings.
430-
--verbose Increase the verbosity of the output.
417+
$ shopify app function run [--client-id <value> | -c <value>] [-e <value>] [-i <value>] [-j] [--no-color] [--path
418+
<value>] [--reset | ] [--verbose]
419+
420+
FLAGS
421+
-c, --config=<value> The name of the app configuration.
422+
-e, --export=<value> Name of the WebAssembly export to invoke.
423+
-i, --input=<value> The input JSON to pass to the function. If omitted, standard input is used.
424+
-j, --json Output the result as JSON.
425+
--client-id=<value> The Client ID of your app.
426+
--no-color Disable color output.
427+
--path=<value> The path to your function directory.
428+
--reset Reset all your settings.
429+
--verbose Increase the verbosity of the output.
431430
432431
DESCRIPTION
433432
Run a function locally for testing.

packages/cli/oclif.manifest.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,6 +1136,7 @@
11361136
"description": "The client that invoked this command.",
11371137
"env": "SHOPIFY_FLAG_INVOKED_BY",
11381138
"hasDynamicHelp": false,
1139+
"hidden": true,
11391140
"multiple": false,
11401141
"name": "invoked-by",
11411142
"type": "option"

0 commit comments

Comments
 (0)