Method register

src/command.ts:158–306

* Registers the command with the client. This is used to initially set up * all the commands and wraps their functionality with analytics and error * handling. * @param client the client object (from src/index.js).

(client: CLIClient)

   * @param client the client object (from src/index.js).
   */
  register(client: CLIClient): void {
    this.client = client;
    const program = client.cli;
    const cmd = program.command(this.cmd);
    if (this.descriptionText) {
      cmd.description(this.descriptionText);
    }
    if (this.aliases) {
      cmd.aliases(this.aliases);
    }
    this.options.forEach((args) => {
      const flags = args.shift();
      cmd.option(flags, ...args);
    });

    if (this.helpText) {
      cmd.on("--help", () => {
        console.log(); // Seperates the help text from global options.
        console.log(this.helpText);
      });
    }

    // 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).
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    cmd.action((...args: any[]) => {
      const runner = this.runner();
      const start = process.uptime();
      const options = last(args);
      // We do not want to provide more arguments to the action functions than
      // we are able to - we're not sure what the ripple effects are. Our
      // action functions are supposed to be of the form (options, ...args)
      // where `...args` are the <required> and [optional] arguments of the
      // command. Therefore, if we check the number of arguments we have
      // against the number of arguments the action function has, we can error
      // out if we would provide too many.
      // TODO(bkendall): it would be nice to not depend on this internal
      //   property of Commander, but that's the limitation we have today. What
      //   we would like is the following:
      //   > if (args.length > this.actionFn.length)
      if (args.length - 1 > cmd._args.length) {
        if (!getInheritedOption(options, "json") && !options.isMCP) {
          useConsoleLoggers();
        }
        client.errorOut(
          new FirebaseError(
            `Too many arguments. Run ${clc.bold(
              "firebase help " + this.name,
            )} for usage instructions`,
            { exit: 1 },
          ),
        );
        return;
      }