Fix misleading typing for options.json. (#9275)

Author: yuchenshi

firebase-vscode/src/options.ts

@@ -26,7 +26,6 @@ const defaultOptions: Readonly<VsCodeOptions> = {
   projectNumber: "",
   projectRoot: "",
   account: "",
-  json: true,
   nonInteractive: true,
   interactive: false,
   debug: false,

src/checkValidTargetFilters.spec.ts

@@ -13,7 +13,6 @@ const SAMPLE_OPTIONS: Options = {
   only: "",
   except: "",
   nonInteractive: false,
-  json: false,
   interactive: false,
   debug: false,
   force: false,

src/command.ts

@@ -313,6 +313,7 @@ export class Command {
     }
 
     if (getInheritedOption(options, "json")) {
+      options.interactive = false;
       options.nonInteractive = true;
     } else if (!options.isMCP) {
       useConsoleLoggers();

src/commands/firestore-backups-delete.ts

@@ -34,11 +34,7 @@ export const command = new Command("firestore:backups:delete <backup>")
       throw new FirebaseError(`Failed to delete the backup ${backupName}`, { original: err });
     }
 
-    if (options.json) {
-      logger.info(JSON.stringify(backup, undefined, 2));
-    } else {
-      logger.info(clc.bold(`Successfully deleted ${clc.yellow(backupName)}`));
-    }
+    logger.info(clc.bold(`Successfully deleted ${clc.yellow(backupName)}`));
 
     return backup;
   });

src/commands/firestore-backups-get.ts

@@ -1,25 +1,19 @@
 import { Command } from "../command";
-import { logger } from "../logger";
 import { requirePermissions } from "../requirePermissions";
 import { Emulators } from "../emulator/types";
 import { warnEmulatorNotSupported } from "../emulator/commandUtils";
-import { FirestoreOptions } from "../firestore/options";
 import { Backup, getBackup } from "../gcp/firestore";
 import { PrettyPrint } from "../firestore/pretty-print";
 
 export const command = new Command("firestore:backups:get <backup>")
   .description("get a Cloud Firestore database backup")
   .before(requirePermissions, ["datastore.backups.get"])
   .before(warnEmulatorNotSupported, Emulators.FIRESTORE)
-  .action(async (backupName: string, options: FirestoreOptions) => {
+  .action(async (backupName: string) => {
     const backup: Backup = await getBackup(backupName);
     const printer = new PrettyPrint();
 
-    if (options.json) {
-      logger.info(JSON.stringify(backup, undefined, 2));
-    } else {
-      printer.prettyPrintBackup(backup);
-    }
+    printer.prettyPrintBackup(backup);
 
     return backup;
   });

src/commands/firestore-backups-list.ts

@@ -1,5 +1,4 @@
 import { Command } from "../command";
-import { logger } from "../logger";
 import { requirePermissions } from "../requirePermissions";
 import { Emulators } from "../emulator/types";
 import { warnEmulatorNotSupported } from "../emulator/commandUtils";
@@ -23,17 +22,15 @@ export const command = new Command("firestore:backups:list")
     const listBackupsResponse: ListBackupsResponse = await listBackups(options.project, location);
     const backups: Backup[] = listBackupsResponse.backups || [];
 
-    if (options.json) {
-      logger.info(JSON.stringify(listBackupsResponse, undefined, 2));
-    } else {
-      printer.prettyPrintBackups(backups);
-      if (listBackupsResponse.unreachable && listBackupsResponse.unreachable.length > 0) {
-        logWarning(
-          "We were not able to reach the following locations: " +
-            listBackupsResponse.unreachable.join(", "),
-        );
-      }
+    printer.prettyPrintBackups(backups);
+    if (listBackupsResponse.unreachable && listBackupsResponse.unreachable.length > 0) {
+      logWarning(
+        "We were not able to reach the following locations: " +
+          listBackupsResponse.unreachable.join(", "),
+      );
     }
 
+    // TODO: Consider returning listBackupResponse instead for --json. This will
+    // be a breaking change but exposes .unreachable, not just .backups.
     return backups;
   });

src/commands/firestore-backups-schedules-create.ts

@@ -81,13 +81,9 @@ export const command = new Command("firestore:backups:schedules:create")
       weeklyRecurrence,
     );
 
-    if (options.json) {
-      logger.info(JSON.stringify(backupSchedule, undefined, 2));
-    } else {
-      logger.info(
-        clc.bold(`Successfully created ${printer.prettyBackupScheduleString(backupSchedule)}`),
-      );
-    }
+    logger.info(
+      clc.bold(`Successfully created ${printer.prettyBackupScheduleString(backupSchedule)}`),
+    );
 
     return backupSchedule;
   });

src/commands/firestore-backups-schedules-delete.ts

@@ -36,11 +36,7 @@ export const command = new Command("firestore:backups:schedules:delete <backupSc
       });
     }
 
-    if (options.json) {
-      logger.info(JSON.stringify(backupSchedule, undefined, 2));
-    } else {
-      logger.info(clc.bold(`Successfully deleted ${clc.yellow(backupScheduleName)}`));
-    }
+    logger.info(clc.bold(`Successfully deleted ${clc.yellow(backupScheduleName)}`));
 
     return backupSchedule;
   });

src/commands/firestore-backups-schedules-list.ts

@@ -1,5 +1,4 @@
 import { Command } from "../command";
-import { logger } from "../logger";
 import { requirePermissions } from "../requirePermissions";
 import { Emulators } from "../emulator/types";
 import { warnEmulatorNotSupported } from "../emulator/commandUtils";
@@ -24,11 +23,7 @@ export const command = new Command("firestore:backups:schedules:list")
       databaseId,
     );
 
-    if (options.json) {
-      logger.info(JSON.stringify(backupSchedules, undefined, 2));
-    } else {
-      printer.prettyPrintBackupSchedules(backupSchedules, databaseId);
-    }
+    printer.prettyPrintBackupSchedules(backupSchedules, databaseId);
 
     return backupSchedules;
   });

src/commands/firestore-backups-schedules-update.ts

@@ -30,13 +30,9 @@ export const command = new Command("firestore:backups:schedules:update <backupSc
       retention,
     );
 
-    if (options.json) {
-      logger.info(JSON.stringify(backupSchedule, undefined, 2));
-    } else {
-      logger.info(
-        clc.bold(`Successfully updated ${printer.prettyBackupScheduleString(backupSchedule)}`),
-      );
-    }
+    logger.info(
+      clc.bold(`Successfully updated ${printer.prettyBackupScheduleString(backupSchedule)}`),
+    );
 
     return backupSchedule;
   });