Inherit arguments to default subcommand

[Justinidlerz]

You can use the option on the subcommand.Like so:

pm.js

var program = require('commander');
program
  .command('default', 'default command', { noHelp: true, isDefault: true });

program
  .command('server')
  .option('-p --port <port>', 'port', /^\d+$/, 3000)
   .action(port => {
     // start a server with the option port
   })
  .parse(process.argv);

pm-default.js

#!/usr/bin/env node
var program = require('commander');

program
    .option('-t --test <number>', 'Test inherit subcommand option', /^\d+$/, 500)
    .parse(process.argv);

console.log('default');
console.log(program.test);

RUN

./pm.js -t 800 // echo default 800

[shadowspawn]

I was bit concerned whether this was a good idea, but I see it requested in #461, and I checked yargs and it allows options for default command, so will be considered further.

[shadowspawn]

I have a concern that unrecognised commands will get passed to default hander as arguments. For example with commands server and default:

# oops, server typo calls default command with argument servers
./pm.js servers -p 90

Basically the fallback error handling shifts from the outer program to the default command. Heavier weight change than might first appear.

[shadowspawn]

I still have mixed feelings about this one. I am leaving it open but not considering it for v3, so no action likely for a while.

[shadowspawn]

I was concerned about what I thought was changing behaviour to call default subcommand when an option was specified, but was looking at that code recently and saw that this is exactly what happens if an unrecognised argument is included on the command line such as when the default command takes an argument.

Happier that this change is consistent with existing behaviour and will be taking another look after v3.

[shadowspawn]

Finally convinced myself this is appropriate!

1. I do not wish to change the main executable example examples/pm. I consider a default a less common use.
2. stale changes to package.json

Given it is a one line change + tests, might be easier to redo a new PR against develop branch?

[shadowspawn]

@Justinidlerz
Are you interested in reworking this, or should I take it over?

[shadowspawn]

Stripped down pm.js

var program = require('commander');

program
  .command('default', 'default command', { noHelp: true, isDefault: true })
  .parse(process.argv);

pm-default.js

#!/usr/bin/env node
var program = require('commander');
const util = require('util')

console.log('Called default subcommand with')
console.log(process.argv.slice(2));

program
  .arguments('<file>')
    .option('-a, --all')
    .action((file) => {
      console.log(`File is ${file}`);
    })
    .parse(process.argv);

console.log(`option all is ${program.all}`);

Behaviour before fix:

$ node pm.js
Called default subcommand with
[]
option all is undefined
$ node pm.js x
Called default subcommand with
[ 'x', '[object Object]' ]
File is x
option all is undefined
$ node pm.js --all
error: unknown option '--all'
$ node pm.js x --all
Called default subcommand with
[ 'x', '[object Object]', '--all' ]
File is x
option all is true

After fix:

$ node pm.js
Called default subcommand with
[]
option all is undefined
$ node pm.js x
Called default subcommand with
[ 'x', '[object Object]' ]
File is x
option all is undefined
$ node pm.js --all
Called default subcommand with
[ '--all' ]
option all is true
$ node pm.js x --all
Called default subcommand with
[ 'x', '[object Object]', '--all' ]
File is x
option all is true

[Justinidlerz]

@shadowspawn Sorry, it's a loooooong time PR, I forgot the contents. Let me see again it to recall.

[shadowspawn]

I'm going to start work on this for 4.0.0 in a new PR. I'll add you (@Justinidlerz) as co-author on the commit.

[shadowspawn]

Closing in favour of #1047 which finishes this work.

[shadowspawn]

#1047 has been merged to develop and will be released in v4.0.0.

Thank you for your contributions.

[shadowspawn]

v4.0.0 has been released.

Thank you for your contributions.