refactor: [Command] alias, aliases

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

README.md

@@ -436,27 +436,27 @@ Add a prepared `option`.
 
 #### `Command#alias([alias])`
 
-Get an alias for the command or add command aliases.
+Get an alias for the command or add a command alias.
 
 > 👉 **Note**: This method can be called more than once to add multiple aliases.
 
 ##### Overloads
 
-- `alias(alias: List<string> | string): this`
+- `alias(alias: string): this`
 - `alias(): CommandName`
 
 ##### Parameters
 
-- `alias` ([`List<string>`](#list) | `string`)
-  — an alias, or list of aliases, for the command
+- `alias` (`string`)
+  — an alias for the command
 
 ##### Returns
 
 ([`CommandName`](#commandname) | [`this`](#commandinfo)) Command alias or `this` command
 
 #### `Command#aliases([aliases])`
 
-Get or set aliases for the command.
+Get or add aliases for the command.
 
 ##### Overloads
 
@@ -2025,6 +2025,8 @@ Command metadata (TypeScript interface).
 
 #### Properties
 
+- `aliases` (`Set<string>`)
+  — list of command aliases
 - `arguments` ([`Argument[]`](#argumentinfo))
   — list of command arguments
 - `helpOption` ([`Option`](#optioninfo) | `null` | `undefined`)

src/interfaces/__tests__/command.metadata.spec-d.mts

@@ -25,6 +25,12 @@ describe('unit-d:interfaces/CommandMetadata', () => {
     expectTypeOf<TestSubject>().toExtend<Expect>()
   })
 
+  it('should match [aliases: Set<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('aliases')
+      .toEqualTypeOf<Set<string>>()
+  })
+
   it('should match [arguments: Argument[]]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('arguments')

src/interfaces/command.metadata.mts

@@ -26,6 +26,11 @@ type Skip = 'arguments' | 'options' | 'subcommands'
  * @extends {Omit<CommandInfo,Skip>}
  */
 interface CommandMetadata extends Omit<CommandInfo, Skip> {
+  /**
+   * List of command aliases.
+   */
+  aliases: Set<string>
+
   /**
    * List of command arguments.
    *

src/lib/__snapshots__/command.snap

@@ -65,6 +65,7 @@ Command {
     "name": "help",
     "helpCommand": null,
     "hidden": false,
+    "aliases": Set {},
     "arguments": [],
     "helpOption": Option {
       "info": {
@@ -119,7 +120,6 @@ Command {
     "subcommands": Map {},
     "version": undefined,
     "action": undefined,
-    "aliases": Set {},
     "done": undefined,
     "exit": undefined,
     "optionPriority": "local",
@@ -154,6 +154,7 @@ Command {
       "name": undefined,
       "description": undefined,
       "hidden": false,
+      "aliases": Set {},
       "arguments": [],
       "helpCommand": [Circular],
       "helpOption": Option {
@@ -211,7 +212,6 @@ Command {
       },
       "version": undefined,
       "action": undefined,
-      "aliases": Set {},
       "done": undefined,
       "exit": undefined,
       "optionPriority": "local",

src/lib/__tests__/command.spec.mts

@@ -234,7 +234,7 @@ describe('unit:lib/Command', () => {
       aliases = new Set([alias1, alias2])
     })
 
-    it('should add command aliases and return `this`', () => {
+    it('should add command alias and return `this`', () => {
       // Arrange
       const subject: TestSubject = new TestSubject('timezone', {
         aliases: alias2
@@ -263,29 +263,29 @@ describe('unit:lib/Command', () => {
   })
 
   describe('#aliases', () => {
-    it('should return list of command aliases', () => {
-      // Act
-      const result = new TestSubject().aliases()
-
-      // Expect
-      expect(result).to.be.instanceof(Set).and.empty
-      expect(result).to.not.be.frozen
-    })
-
-    it('should set command aliases and return `this`', () => {
+    it('should add command aliases and return `this`', () => {
       // Arrange
-      const aliases: Set<string> = new Set(['tz'])
+      const a1: string = 't'
+      const a2: string = 'tz'
       const property: string = 'info.aliases'
-      const subject: TestSubject = new TestSubject('timezone', { aliases: 't' })
+      const subject: TestSubject = new TestSubject('timezone', { aliases: a1 })
 
       // Act
-      const result = subject.aliases(aliases)
+      const result = subject.aliases(a2)
 
       // Expect
       expect(result).to.eq(subject)
       expect(result).to.have.nested.property(property).be.instanceof(Set)
-      expect(result).to.have.nested.property(property).eql(aliases)
-      expect(result).to.have.nested.property(property).not.eq(aliases)
+      expect(result).to.have.nested.property(property).eql(new Set([a1, a2]))
+    })
+
+    it('should return list of command aliases', () => {
+      // Act
+      const result = new TestSubject().aliases()
+
+      // Expect
+      expect(result).to.be.instanceof(Set).and.empty
+      expect(result).to.not.be.frozen
     })
   })
 

src/lib/command.mts

@@ -267,6 +267,7 @@ class Command extends Helpable {
 
     this.info = {
       ...this.info,
+      aliases: new Set(),
       arguments: [],
       helpCommand: null,
       helpOption: null,
@@ -313,7 +314,7 @@ class Command extends Helpable {
     })
 
     this.action(this.info.action)
-    this.aliases(this.info.aliases)
+    this.aliases(data.aliases)
     this.done(this.info.done)
     this.exiter(this.info.exit)
     this.helpCommand(data.helpCommand)
@@ -613,22 +614,20 @@ class Command extends Helpable {
   }
 
   /**
-   * Add command aliases.
+   * Add a command alias.
    *
-   * > 👉 **Note**: This method can be called more than once to add multiple
-   * > aliases.
-   *
-   * @see {@linkcode List}
+   * > 👉 **Note**: This method can be called more than once
+   * > to add multiple aliases.
    *
    * @public
    * @instance
    *
-   * @param {List<string> | string} alias
-   *  An alias, or list of aliases, for the command
+   * @param {string} alias
+   *  An alias for the command
    * @return {this}
    *  `this` command
    */
-  public alias(alias: List<string> | string): this
+  public alias(alias: string): this
 
   /**
    * Get an alias for the command.
@@ -639,33 +638,31 @@ class Command extends Helpable {
    * @instance
    *
    * @return {CommandName}
-   *  Alias for `this` command
+   *  Command alias
    */
   public alias(): CommandName
 
   /**
-   * Get an alias for the command or add command aliases.
+   * Get or add a command alias.
    *
    * @see {@linkcode CommandName}
-   * @see {@linkcode List}
    *
    * @public
    * @instance
    *
-   * @param {List<string> | string} [alias]
-   *  An alias, or list of aliases, for the command
+   * @param {string} [alias]
+   *  An alias for the command
    * @return {CommandName | this}
    *  Command alias or `this` command
    */
-  public alias(alias?: List<string> | string): CommandName | this {
+  public alias(alias?: string): CommandName | this {
     if (!arguments.length) return fallback([...this.aliases()][0], null)
     ok(this.info.aliases instanceof Set, 'expected `info.aliases`')
-    for (const x of toList(alias)) this.info.aliases.add(x)
-    return this
+    return this.info.aliases.add(alias!), this
   }
 
   /**
-   * Set aliases for the command.
+   * Add aliases for the command.
    *
    * @see {@linkcode List}
    *
@@ -686,12 +683,12 @@ class Command extends Helpable {
    * @instance
    *
    * @return {Set<string>}
-   *  List of aliases for `this` command
+   *  List of command aliases
    */
   public aliases(): Set<string>
 
   /**
-   * Get or set aliases for the command.
+   * Get or add aliases for the command.
    *
    * @see {@linkcode List}
    *
@@ -706,8 +703,9 @@ class Command extends Helpable {
   public aliases(
     aliases?: List<string> | string | null | undefined
   ): Set<string> | this {
-    if (!arguments.length) return new Set(toList(this.info.aliases))
-    return this.info.aliases = new Set(toList(aliases)), this
+    if (!arguments.length) return this.info.aliases
+    for (const alias of toList(aliases)) this.alias(alias)
+    return this
   }
 
   /**