Merge pull request #6691 from Shopify/app_bulk_execute_no_output_file_without_watch

Make `--output-file` flag dependent on `--watch` in bulk operations

Author: nickwesselman

packages/app/src/cli/commands/app/bulk/execute.ts

@@ -29,7 +29,7 @@ export default class BulkExecute extends AppLinkedCommand {
       query,
       variables: flags.variables,
       variableFile: flags['variable-file'],
-      watch: flags.watch,
+      watch: flags.watch ?? false,
       outputFile: flags['output-file'],
       ...(flags.version && {version: flags.version}),
     })

packages/app/src/cli/flags.ts

@@ -64,13 +64,14 @@ export const bulkOperationFlags = {
     parse: async (input) => normalizeStoreFqdn(input),
   }),
   watch: Flags.boolean({
-    description: 'Wait for bulk operation results before exiting.',
+    description: 'Wait for bulk operation results before exiting. Defaults to false.',
     env: 'SHOPIFY_FLAG_WATCH',
-    default: false,
   }),
   'output-file': Flags.string({
-    description: 'The file path where results should be written. If not specified, results will be written to STDOUT.',
+    description:
+      'The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.',
     env: 'SHOPIFY_FLAG_OUTPUT_FILE',
+    dependsOn: ['watch'],
   }),
   version: Flags.string({
     description: 'The API version to use for the bulk operation. If not specified, uses the latest stable version.',

packages/cli/oclif.manifest.json

@@ -125,7 +125,10 @@
           "type": "boolean"
         },
         "output-file": {
-          "description": "The file path where results should be written. If not specified, results will be written to STDOUT.",
+          "dependsOn": [
+            "watch"
+          ],
+          "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.",
           "env": "SHOPIFY_FLAG_OUTPUT_FILE",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -212,7 +215,7 @@
         },
         "watch": {
           "allowNo": false,
-          "description": "Wait for bulk operation results before exiting.",
+          "description": "Wait for bulk operation results before exiting. Defaults to false.",
           "env": "SHOPIFY_FLAG_WATCH",
           "name": "watch",
           "type": "boolean"