version 5, allowUnknownOption(true) not work

[zhouhoujun]

version 5, allowUnknownOption(true) not work.
eg.

program
    .command('build [taskfile]')
    .description('build the application')
    .option('--config [string]', 'path to configuration file for activities build')
    .option('--debug [bool]', 'enable debug log or not')
    .option('-d, --deploy [bool]', 'run deploy activity')
    .allowUnknownOption(true)
    .action((taskfile, options) => {
        requireRegisters();
        taskfile = vaildifyFile(taskfile);
        if (options.boot) {
            requireCwd(taskfile);
        } else {
            runActivity(taskfile, options);
        }
    });

[shadowspawn]

The behaviour did change in v5, but working in my test.

What did you type on command line, and what is not working?

const { program } = require('commander');

program
    .command('build [taskfile]')
    .description('build the application')
    .option('--config [string]', 'path to configuration file for activities build')
    .option('--debug [bool]', 'enable debug log or not')
    .option('-d, --deploy [bool]', 'run deploy activity')
    .allowUnknownOption(true)
    .action((taskfile, cmd) => {
      console.log('args:', cmd.args);
      console.log('opts:', cmd.opts());
    });
  
program.parse();

$ node index.js build --config aaa --unexpected
args: [ '--unexpected' ]
opts: { config: 'aaa', debug: undefined, deploy: undefined }

[shadowspawn]

@zhouhoujun

I just noticed your example code checks options.boot. Did you expect Commander to process the unknown options into properties? Commander does not do that, it just allows the unknown options to be included on the command line for further processing by your code or the commands the arguments (including unknown options) are passed to.

[zhouhoujun]

@shadowspawn
eg.

xxx build  --deploy --setversion=1.1.0

will get --setversion=1.1.0 as taskfile

[shadowspawn]

Yes. The allowUnknownOptions just suppresses the error message for unknown options and passes them through as arguments for further processing by you.

const { program } = require('commander');

program
    .command('build <taskfile>')
    .description('build the application')
    .option('--config <string>', 'path to configuration file for activities build')
    .option('--debug', 'enable debug log or not')
    .option('-d, --deploy', 'run deploy activity')
    .allowUnknownOption(true)
    .action((taskfile, cmd) => {
      console.log('taskfile: ', taskfile);
      console.log('args: ', cmd.args);
      console.log('opts: ', cmd.opts());
    });
  
program.parse();

$ node index.js build  --deploy NAME --setversion=1.1.0
taskfile:  NAME
args:  [ 'NAME', '--setversion=1.1.0' ]
opts:  { config: undefined, debug: undefined, deploy: true }

---

A couple of other optional suggestions for your example program:

1. You probably do not want the [bool].
2. I recommend <required> values for options over [optional] values, unless you really want optional.

[shadowspawn]

An answer was provided, and no further activity in a month. Closing this as resolved.

Feel free to open a new issue if it comes up again, with new information and renewed interest.