Added alias support and alias appdistribution:groups:* (#7962)

* Added alias support and alias appgistribution:groups:*

* fix shrinkwrap

* Make groups command accessible as a node module

* remove repeated entry so help test is not repetitive

* Swap primary and alias

* rename files, better approach for module

Author: joehan

CHANGELOG.md

@@ -2,4 +2,5 @@
 - Moved firebase-tools-ui server.js logic to fireabse-tools to run it in-memory. (#7897)
 - Updates `superstatic` to `9.1.0` (#7929).
 - Added the appdistribution:group:list and appdistribution:testers:list commands.
+- Aliased `appdistribution:group:*` commands to `appdistribution:groups:*`.
 - Updated the Firebase Data Connect local toolkit to v1.7.2, which includes bug fixes for `@auth` expressions that reference the `auth` variable, `Optional` arrays in Swift codegen, and updates Kotlin codegen to use fully-qualified class names everywhere. (#7968)

npm-shrinkwrap.json

@@ -110,7 +110,7 @@
     "cjson": "^0.3.1",
     "cli-table": "0.3.11",
     "colorette": "^2.0.19",
-    "commander": "^4.0.1",
+    "commander": "^5.1.0",
     "configstore": "^5.0.1",
     "cors": "^2.8.5",
     "cross-env": "^5.1.3",

package.json

@@ -18,7 +18,7 @@ const updateNotifier = updateNotifierPkg({ pkg });
 import { marked } from "marked";
 marked.use(markedTerminal() as any);
 
-import { Command } from "commander";
+import { CommanderStatic } from "commander";
 import { join } from "node:path";
 import { SPLAT } from "triple-beam";
 import { stripVTControlCharacters } from "node:util";
@@ -34,7 +34,7 @@ import * as utils from "../utils";
 import * as winston from "winston";
 
 let args = process.argv.slice(2);
-let cmd: Command;
+let cmd: CommanderStatic;
 
 function findAvailableLogFile(): string {
   const candidates = ["firebase-debug.log"];

src/bin/firebase.ts

@@ -24,6 +24,7 @@ describe("Command", () => {
         },
         ["foo", "bar"],
       );
+      command.alias("example2");
       command.help("here's how!");
       command.action(() => {
         // do nothing

src/command.spec.ts

@@ -37,6 +37,7 @@ export class Command {
   private descriptionText = "";
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private options: any[][] = [];
+  private aliases: string[] = [];
   private actionFn: ActionFunction = (): void => {
     // noop by default, unless overwritten by `.action(fn)`.
   };
@@ -62,6 +63,16 @@ export class Command {
     return this;
   }
 
+  /**
+   * 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 {
+    this.aliases.push(alias);
+    return this;
+  }
+
   /**
    * Sets any options for the command.
    *
@@ -138,6 +149,9 @@ export class Command {
     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);

src/command.ts

@@ -4,8 +4,9 @@ import { requireAuth } from "../requireAuth";
 import { AppDistributionClient } from "../appdistribution/client";
 import { getProjectName } from "../appdistribution/options-parser-util";
 
-export const command = new Command("appdistribution:group:create <displayName> [alias]")
+export const command = new Command("appdistribution:groups:create <displayName> [alias]")
   .description("create group in project")
+  .alias("appdistribution:group:create")
   .before(requireAuth)
   .action(async (displayName: string, alias?: string, options?: any) => {
     const projectName = await getProjectName(options);

src/commands/appdistribution-group-create.ts renamed to src/commands/appdistribution-groups-create.ts

@@ -5,8 +5,9 @@ import { FirebaseError } from "../error";
 import { AppDistributionClient } from "../appdistribution/client";
 import { getProjectName } from "../appdistribution/options-parser-util";
 
-export const command = new Command("appdistribution:group:delete <alias>")
+export const command = new Command("appdistribution:groups:delete <alias>")
   .description("delete group from a project")
+  .alias("appdistribution:group:delete")
   .before(requireAuth)
   .action(async (alias: string, options: any) => {
     const projectName = await getProjectName(options);

src/commands/appdistribution-group-delete.ts renamed to src/commands/appdistribution-groups-delete.ts

@@ -11,8 +11,9 @@ import * as utils from "../utils";
 
 const Table = require("cli-table");
 
-export const command = new Command("appdistribution:group:list")
+export const command = new Command("appdistribution:groups:list")
   .description("list groups in project")
+  .alias("appdistribution:group:list")
   .before(requireAuth)
   .action(async (options?: Options): Promise<ListGroupsResponse> => {
     const projectName = await getProjectName(options);

src/commands/appdistribution-group-list.ts renamed to src/commands/appdistribution-groups-list.ts

@@ -26,9 +26,10 @@ export function load(client: any): any {
   client.appdistribution.testers.add = loadCommand("appdistribution-testers-add");
   client.appdistribution.testers.delete = loadCommand("appdistribution-testers-remove");
   client.appdistribution.group = {};
-  client.appdistribution.group.list = loadCommand("appdistribution-group-list");
-  client.appdistribution.group.create = loadCommand("appdistribution-group-create");
-  client.appdistribution.group.delete = loadCommand("appdistribution-group-delete");
+  client.appdistribution.group.list = loadCommand("appdistribution-groups-list");
+  client.appdistribution.group.create = loadCommand("appdistribution-groups-create");
+  client.appdistribution.group.delete = loadCommand("appdistribution-groups-delete");
+  client.appdistribution.groups = client.appdistribution.group;
   client.apps = {};
   client.apps.create = loadCommand("apps-create");
   client.apps.list = loadCommand("apps-list");