Add ephemeral and emulator dataDir flag/properties for later use. (#8…

schema/firebase-config.json

@@ -1194,6 +1194,9 @@
                     },
                     "type": "object"
                 },
+                "dataDir": {
+                    "type": "string"
+                },
                 "database": {
                     "additionalProperties": false,
                     "properties": {

src/command.ts

@@ -66,7 +66,7 @@
 
   /**
    * Sets an alias for a command.
    * @param aliases an alternativre name for the command. Users will be able to call the command via this name.
    * @return the command, for chaining.
    */
   alias(alias: string): Command {
@@ -75,10 +75,10 @@
   }
 
   /**
    * Sets any options for the command.
    *
    * @example
    *   command.option("-d, --debug", "turn on debugging", false)
    *
    * @param args the commander-style option definition.
    * @return the command, for chaining.
@@ -90,16 +90,28 @@
   }
 
   /**
    * Sets up --force flag for the command.
    *
    * @param message overrides the description for --force for this command
    * @returns the command, for chaining
    */
   withForce(message?: string): Command {
     this.options.push(["-f, --force", message || "automatically accept all interactive prompts"]);
     return this;
   }
 
+  /**
+   * Adds the --ephemeral flag to the command.
+   * @return The command, for chaining.
+   */
+  withEphemeral(): Command {
+    this.option(
+      "--ephemeral",
+      "ignore emulators.dataDir and start with a clean state",
+      false, // Default value if the flag is not present
+    );
+    return this;
+  }
   /**
    * Attaches a function to run before the command's action function.
    * @param fn the function to run.
@@ -117,7 +129,7 @@
    *
    * This text is displayed when:
    *   - the `--help` flag is passed to the command, or
    *   - the `help <command>` command is used.
    *
    * @param t the human-readable help text.
    * @return the command, for chaining.
@@ -154,8 +166,8 @@
       cmd.aliases(this.aliases);
     }
     this.options.forEach((args) => {
       const flags = args.shift();
       cmd.option(flags, ...args);
     });
 
     if (this.helpText) {
@@ -166,7 +178,7 @@
     }
 
     // See below about using this private property
     this.positionalArgs = cmd._args;
 
     // args is an array of all the arguments provided for the command PLUS the
     // options object as provided by Commander (on the end).

src/commands/emulators-exec.ts

@@ -8,6 +8,7 @@ export const command = new Command("emulators:exec <script>")
   .description(
     "start the local Firebase emulators, run a test script, then shut down the emulators",
   )
+  .withEphemeral()
   .option(commandUtils.FLAG_ONLY, commandUtils.DESC_ONLY)
   .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
   .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)

src/commands/emulators-start.ts

@@ -20,6 +20,7 @@ export const command = new Command("emulators:start")
   .before(commandUtils.setExportOnExitOptions)
   .before(commandUtils.beforeEmulatorCommand)
   .description("start the local Firebase emulators")
+  .withEphemeral()
   .option(commandUtils.FLAG_ONLY, commandUtils.DESC_ONLY)
   .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
   .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)

src/firebaseConfig.ts

@@ -252,6 +252,7 @@ export type EmulatorsConfig = {
     host?: string;
     port?: number;
   };
+  dataDir?: string;
 };
 
 export type ExtensionsConfig = Record<string, string>;