Help/usage describes first path only, duplicated, for commands with multiple paths

[erictheswift]

When a command has multiple paths and the user types a partial command, the error message shows duplicate suggestions instead of listing all available paths.

Reproduce

cli.register(
  class X extends Command {
    static override paths = [
      ['ls', 'foo'],
      ['ls', 'foos'], 
      ['ls', 'bar'],
      ['ls', 'bars'],
    ]

    async execute() {}
  },
)

$ cli ls
Unknown Syntax Error: Command not found; did you mean one of:

  0. cli ls foo
  1. cli ls foo  
  2. cli ls foo
  3. cli ls foo

While running ls

Also affects --help:

$ cli ls --help
Multiple commands match your selection:
  0. cli ls foo
  1. cli ls foo
  2. cli ls foo
  3. cli ls foo
Run again with -h=<index> to see the longer details of any of those commands.

Expected

Should show all distinct paths:

$ cli ls --help
Multiple commands match your selection:
  0. cli ls foo
  1. cli ls foos
  2. cli ls bar  
  3. cli ls bars
Run again with -h=<index> to see the longer details of any of those commands.

Root Cause

The usage formatter logic appears to be always using the first path, see

clipanion/sources/core.ts

Line 795 in 434b5a6

segments.push(...this.paths[0]);

[erictheswift]

Looked through it — supporting natively will requires some refactoring and having specific path passed around scattered usage() apis. This could allow fancier usage output, e.g. grouping all aliases in one entry and displaying options/parameters once.

However this patch masks the issue for now and makes clipanion behave according to expectations:

// dirty workaround for: https://github.com/arcanis/clipanion/issues/177
const registerUnaware = cli.register
cli.register = function registerMultiplePathsAware(commandClass): void {
  if (commandClass.paths && commandClass.paths.length > 1) {
    for (const path of commandClass.paths) {
      registerUnaware.call(this, class extends (commandClass) {
          static paths = [path]
      })
    }
  } else {
    registerUnaware.call(this, commandClass)
  }
}