add opts() for getting key-value pairs

[tonylukasavage]

A common usage pattern I have when using commander is to process the CLI in a bin file and defer all actual program-specific execution to a separate module. I often pass all options gathered from commander straight my module, like this:

#!/usr/bin/env node

var program = require('commander'),
  mymodule = require('mymodule');

// setup the program object

mymodule(program);

While this works, it would be nice if the object passed through included only the options I specified when setting up the program object.

This PR add the opts() function to the program object (via Command.prototype) so as to return the options, with special handling for the version, as a simple object of key-value pairs. No parsing Option objects, no additional properties associated with the program obejcts, I can then do the following in my above example to get the desired behavior.

#!/usr/bin/env node

var program = require('commander'),
  mymodule = require('mymodule');

// setup the program object

mymodule(program.opts());

The included test case also demonstrates this fairly simply.

NOTE: I am entirely open to changing the name of the API. opts() was the first thing to occur to me that wasn't already claimed on the Command object. If someone has a better alternative I'd be happy to update the code and testing.

[SomeKittens]

opts sounds good to me.

@thethomaseffect Look good?

[thethomaseffect]

Looks great, will also unblock anyone who wanted to use the names of JS internals like apply for their options without clobbering the main object, LGTM 👍

[tonylukasavage]

@thethomaseffect any plans for a 2.4.0 or 2.3.1 release? I didn't see any obvious documentation or milestones set up and I was wondering when this would be in an official version.

[thethomaseffect]

Hopefully in the next few days, want to update the documentation first and do some manual testing of a few new features and then should push out the new version!

[FokkeZB]

@tonylukasavage was it a deliberate decision for opts() not to apply the defaults for options?

program
  .version(pkg.version, '-v, --version')
  .description(pkg.description)
  .option('-d, --project-dir [path]', 'the directory containing the project [.]', process.cwd());

console.log(program.projectDir);
console.log(program.opts());

The first log has the default, the second one not.

[tonylukasavage]

You didn't parse()
On Jan 7, 2015 3:25 AM, "Fokke Zandbergen" notifications@github.com wrote:

@tonylukasavage https://github.com/tonylukasavage was it a deliberate
decision for opts() not to apply the defaults for options?

program
.version(pkg.version, '-v, --version')
.description(pkg.description)
.option('-d, --project-dir [path]', 'the directory containing the project [.]', process.cwd());

console.log(program.projectDir);
console.log(program.opts());

The first log has the default, the second one not.

—
Reply to this email directly or view it on GitHub
#262 (comment).

[FokkeZB]

Same result (probably copy pasted it wrong):

program
  .version(pkg.version, '-v, --version')
  .description(pkg.description)
  .option('-d, --project-dir [path]', 'the directory containing the project [.]', process.cwd());

program.parse(process.argv);

console.log(program.projectDir); 
console.log(program.opts());