Commander.js——模具行业从业者必备知识手册

system 2

<h2>Commander.js</h2>

The complete solution for <a href="http://nodejs.org">node.js</a> command-line interfaces, inspired by Ruby's <a href="https://github.com/commander-rb/commander">commander</a>. 
 <a href="http://tj.github.com/commander.js/">API documentation</a>

<h3>Installation</h3>

$ npm install commander

<h3>Option parsing</h3>

Options with commander are defined with the <code>.option()</code> method, also serving as documentation for the options. The example below parses args and options from <code>process.argv</code>, leaving remaining args as the <code>program.args</code> array which were not consumed by options.

<pre><code>
#!/usr/bin/env node

/**

Module dependencies.
*/

var program = require('commander');

program
.version('0.1.0')
.option('-p, --peppers', 'Add peppers')
.option('-P, --pineapple', 'Add pineapple')
.option('-b, --bbq-sauce', 'Add bbq sauce')
.option('-c, --cheese [type]', 'Add the specified type of cheese [marble]', 'marble')
.parse(process.argv);

console.log('you ordered a pizza with:');
if (program.peppers) console.log(' - peppers');
if (program.pineapple) console.log(' - pineapple');
if (program.bbqSauce) console.log(' - bbq');
console.log(' - %s cheese', program.cheese);
</code></pre>

Short flags may be passed as a single arg, for example <code>-abc</code> is equivalent to <code>-a -b -c</code>. Multi-word options such as "--template-engine" are camel-cased, becoming <code>program.templateEngine</code> etc.

Note that multi-word options starting with <code>--no</code> prefix negate the boolean value of the following word. For example, <code>--no-sauce</code> sets the value of <code>program.sauce</code> to false.

<pre><code>
#!/usr/bin/env node

/**

Module dependencies.
*/

var program = require('commander');

program
.option('--no-sauce', 'Remove sauce')
.parse(process.argv);

console.log('you ordered a pizza');
if (program.sauce) console.log(' with sauce');
else console.log(' without sauce');
</code></pre>

To get string arguments from options you will need to use angle brackets <> for required inputs or square brackets [] for optional inputs.

e.g. <code></code>.option('-m --myarg [myVar]', 'my super cool description')<code></code>

Then to access the input if it was passed in.

e.g. <code></code>var myInput = program.myarg<code></code>

NOTE: If you pass a argument without using brackets the example above will return true and not the value passed in.

<h3>Version option</h3>

Calling the <code>version</code> implicitly adds the <code>-V</code> and <code>--version</code> options to the command.
When either of these options is present, the command prints the version number and exits.

$ ./examples/pizza -V
 0.0.1

If you want your program to respond to the <code>-v</code> option instead of the <code>-V</code> option, simply pass custom flags to the <code>version</code> method using the same syntax as the <code>option</code> method.

<pre><code>
program
.version('0.0.1', '-v, --version')
</code></pre>

The version flags can be named anything, but the long option is required.

<h3>Command-specific options</h3>

You can a

<hr>
各位师傅觉得这个方案怎么样？有更好的做法吗？