Support documentation for strict = false command arguments

[mattgibson]

Do you want to request a feature or report a bug?

Feature.

What is the current behavior?

If I specify strict = false and use argv to access whatever variable length string of arguments the user provides, there is no way to document this. The README doesn't mention that there is an arbitrary list of arguments accepted and if I specify this manually by editing the command form e.g.

USAGE
  $ fd start [SERVICES...]

ARGUMENTS
  SERVICES...  a list of service names

Then it gets overwriten next time I run npx oclif command to add a new one.

What is the expected behavior?

(@oclif/command@1.5.13 on macOS) That I can add documentation similar to that for flags with multiple arguments, which will show up in the README and when using the --help flag.

[xavdid]

@mattgibson did you find a solution to this? My only idea right now is to declare the optional arg and then try and parse it out. I've got the following:

export class MyCLI extends Command {
  static strict = false

  static args = [
    {name: 'firstArg', required: true},
    {name: 'secondArg'},
  ]

  async run() {
    this.log(this.args)
    this.log(this.argv)
  }
}

expected:

$ mycli a b c
{ firstArg: 'a', secondArg: [ 'b', 'c' ] }
[ 'a', 'b', 'c' ]

actual:

$ mycli a b c
{ firstArg: 'a', secondArg: 'b' }
[ 'a', 'b', 'c' ]

If I leave off secondArg, then it doesn't show up in --help, which is a bummer.

cc @RasPhilCo

[RasPhilCo]

Added an issue in plugin-help to have it there also.

@xavdid looks like the parser could handle that more clearly, but I'll have to dig in deeper.

[xavdid]

Thanks a bunch! let me know if there's anything I can do to help

[aexvir]

any update on this?