Readme_zh-CN.md

Commander.js

node.js 命令行接口的完整解决方案，灵感来自 Ruby 的 commander。

用其他语言阅读：English | 简体中文

• Commander.js
  • 安装
  • 声明program变量
  • 选项
    • 常用选项类型，boolean和值
    • 默认选项值
    • 其他选项类型，可忽略的布尔值和标志值
    • 自定义选项处理
    • 必需的选项
    • 版本选项
  • Commands
    • 指定参数语法
    • 操作处理程序(Action handler) (子)命令
    • 独立的可执行(子)命令
  • 自动化帮助信息 help
    • 自定义帮助
    • .usage 和 .name
    • .help(cb)
    • .outputHelp(cb)
    • .helpInformation()
    • .helpOption(flags, description)
    • .addHelpCommand()
  • 自定义事件监听
  • 零碎知识
    • .parse() 和 .parseAsync()
    • 避免选项命名冲突
    • TypeScript
    • Node 选项例如 --harmony
    • 调试独立可执行子命令
    • 重载退出(exit)处理
  • 例子
  • 许可证
  • 支持
    • 企业使用Commander

安装

npm install commander

声明program变量

Commander为了方便快速编程导出了一个全局对象。为简洁起见，本README中的示例中使用了它。

const { program } = require('commander');
program.version('0.0.1');

对于可能以多种方式使用commander的大型程序，包括单元测试，最好创建一个本地Command对象来使用。

const { Command } = require('commander');
const program = new Command();
program.version('0.0.1');

选项

.option() 方法用来定义带选项的 commander，同时也用于这些选项的文档。每个选项可以有一个短标识(单个字符)和一个长名字，它们之间用逗号或空格或'|'分开。

选项会被放到 Commander 对象的属性上，多词选项如"--template-engine"会被转为驼峰法program.templateEngine。另请参看可选的新功能避免选项命名冲突

多个短标识可以组合为一个破折号开头的参数：布尔标识和值，并且最后一个标识可以附带一个值。 例如，-a -b -p 80 也可以写作 -ab -p80 甚至 -abp80。

你可以使用--来指示选项的结束，任何剩余的参数会正常使用，而不会被命令解释 这点对于通过另一个命令来传递选项值的情况尤其适用，如:do -- git --version

命令行中的选项位置不是固定的，可以在别的命令参数之前或之后指定

常用选项类型，boolean和值

最常用的两个选项类型是boolean(选项后面不跟值)和选项跟一个值（使用尖括号声明）。除非在命令行中指定，否则两者都是undefined。

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

program
 .option('-d, --debug', 'output extra debugging')
 .option('-s, --small', 'small pizza size')
 .option('-p, --pizza-type <type>', 'flavour of pizza');

program.parse(process.argv);

if (program.debug) console.log(program.opts());
console.log('pizza details:');
if (program.small) console.log('- small pizza size');
if (program.pizzaType) console.log(`- ${program.pizzaType}`);

$ pizza-options -d
{ debug: true, small: undefined, pizzaType: undefined }
pizza details:
$ pizza-options -p
error: option '-p, --pizza-type <type>' argument missing
$ pizza-options -ds -p vegetarian
{ debug: true, small: true, pizzaType: 'vegetarian' }
pizza details:
- small pizza size
- vegetarian
$ pizza-options --pizza-type=cheese
pizza details:
- cheese

program.parse(arguments)会处理参数，没有被使用的program选项会被存放在program.args数组中。

默认选项值

可以为选项设置一个默认值。

const program = require('commander');

program
  .option('-c, --cheese <type>', 'add the specified type of cheese', 'blue');

program.parse(process.argv);

console.log(`cheese: ${program.cheese}`);

$ pizza-options
cheese: blue
$ pizza-options --cheese stilton
cheese: stilton

其他选项类型，可忽略的布尔值和标志值

选项的值为boolean类型时，可以在其长名字前加no-规定这个选项值为false。 单独定义同样使选项默认为真。

如果你先定义了--foo，再加上--no-foo并不会改变它本来的默认值。你可以为一个boolean类型的标识(flag)指定一个默认的布尔值，从命令行里可以重写它的值。

const program = require('commander');

program
  .option('--no-sauce', 'Remove sauce')
  .option('--cheese <flavour>', 'cheese flavour', 'mozzarella')
  .option('--no-cheese', 'plain with no cheese')
  .parse(process.argv);

const sauceStr = program.sauce ? 'sauce' : 'no sauce';
const cheeseStr = (program.cheese === false) ? 'no cheese' : `${program.cheese} cheese`;
console.log(`You ordered a pizza with ${sauceStr} and ${cheeseStr}`);

$ pizza-options
You ordered a pizza with sauce and mozzarella cheese
$ pizza-options --sauce
error: unknown option '--sauce'
$ pizza-options --cheese=blue
You ordered a pizza with sauce and blue cheese
$ pizza-options --no-sauce --no-cheese
You ordered a pizza with no sauce and no cheese

你可以指定一个用作标志的选项，它可以接受值（使用方括号声明，即传值不是必须的）。

const program = require('commander');

program
  .option('-c, --cheese [type]', 'Add cheese with optional type');

program.parse(process.argv);

if (program.cheese === undefined) console.log('no cheese');
else if (program.cheese === true) console.log('add cheese');
else console.log(`add cheese type ${program.cheese}`);

$ pizza-options
no cheese
$ pizza-options --cheese
add cheese
$ pizza-options --cheese mozzarella
add cheese type mozzarella

自定义选项处理

你可以指定一个函数来处理选项的值，接收两个参数：用户传入的值、上一个值(previous value)，它会返回新的选项值。

你可以将选项值强制转换为所需类型，或累积值，或完全自定义处理。

你可以在函数后面指定选项的默认或初始值。

const program = require('commander');

function myParseInt(value, dummyPrevious) {
  // parseInt takes a string and an optional radix
  return parseInt(value);
}

function increaseVerbosity(dummyValue, previous) {
  return previous + 1;
}

function collect(value, previous) {
  return previous.concat([value]);
}

function commaSeparatedList(value, dummyPrevious) {
  return value.split(',');
}

program
  .option('-f, --float <number>', 'float argument', parseFloat)
  .option('-i, --integer <number>', 'integer argument', myParseInt)
  .option('-v, --verbose', 'verbosity that can be increased', increaseVerbosity, 0)
  .option('-c, --collect <value>', 'repeatable value', collect, [])
  .option('-l, --list <items>', 'comma separated list', commaSeparatedList)
;

program.parse(process.argv);

if (program.float !== undefined) console.log(`float: ${program.float}`);
if (program.integer !== undefined) console.log(`integer: ${program.integer}`);
if (program.verbose > 0) console.log(`verbosity: ${program.verbose}`);
if (program.collect.length > 0) console.log(program.collect);
if (program.list !== undefined) console.log(program.list);

$ custom -f 1e2
float: 100
$ custom --integer 2
integer: 2
$ custom -v -v -v
verbose: 3
$ custom -c a -c b -c c
[ 'a', 'b', 'c' ]
$ custom --list x,y,z
[ 'x', 'y', 'z' ]

必需的选项

你可以使用.requiredOption指定一个必需的(强制性的)选项，这样的选项在被解析后必须有一个值，通常情况下这个值在命令行中被指定，或者也许它拥有一个默认的值(可以说，来自环境)。另外，这个方法在格式上和使用.option一样采用标志和说明，以及可选的默认值或自定义处理。

const program = require('commander');

program
  .requiredOption('-c, --cheese <type>', 'pizza must have cheese');

program.parse(process.argv);

$ pizza
error: required option '-c, --cheese <type>' not specified

版本选项

version方法会处理显示版本命令，默认选项标识为-V和--version，当存在时会打印版本号并退出。

program.version('0.0.1');

$ ./examples/pizza -V
0.0.1

你可以自定义标识，通过给version方法再传递一个参数，语法与option方法一致。版本标识名字可以是任意的，但是必须要有长名字。

program.version('0.0.1', '-v, --vers', 'output the current version');

Commands

你可以使用 .command 或者 .addCommand() 为你的最高层命令指定子命令。 这里我们有两种方法可以实现：为命令绑定一个操作处理程序(action handler)，或者将命令单独写成一个可执行文件(稍后我们会详细讨论)。这样的子命令是可以嵌套的(样例)。

在 .command 的第一个参数你可以指定命令的名字以及任何参数。参数可以是 <required>(必须的) or [optional](可选的) , 并且最后一个参数也可以是 variadic...(可变的).

你可以使用 .addCommand() 来向program增加一个已经配置好的子命令

例如:

// 通过绑定操作处理程序实现命令 (这里description的定义和 `.command` 是分开的)
// 返回新生成的命令(即该子命令)以供继续配置
program
  .command('clone <source> [destination]')
  .description('clone a repository into a newly created directory')
  .action((source, destination) => {
    console.log('clone command called');
  });

// 通过独立的的可执行文件实现命令 (注意这里description是作为 `.command` 的第二个参数)
// 返回最顶层的命令以供继续添加子命令
program
  .command('start <service>', 'start named service')
  .command('stop [service]', 'stop named service, or all if no name supplied');

// 分别装配命令
// 返回最顶层的命令以供继续添加子命令
program
  .addCommand(build.makeBuildCommand());  

可以通过调用 .command() 来传递配置的选项。为opts.noHelp指定true 则该命令不会出现生成的帮助输出里。为opts.isDefault指定true会在没有别的指定子命令的时候执行这个命令(样例)。

指定参数语法

你可以通过使用 .arguments 来为最顶级命令指定参数，对于子命令来说参数都包括在 .command 调用之中了。尖括号(e.g. <required>)意味着必须的输入，而方括号(e.g. [optional])则是代表了可选的输入

const program = require('commander');

program
  .version('0.1.0')
  .arguments('<cmd> [env]')
  .action(function (cmd, env) {
    cmdValue = cmd;
    envValue = env;
  });

program.parse(process.argv);

if (typeof cmdValue === 'undefined') {
  console.error('no command given!');
  process.exit(1);
}
console.log('command:', cmdValue);
console.log('environment:', envValue || "no environment given");

一个命令有且仅有最后一个参数是可变的，你需要在参数名后加上 ... 来使它可变，例如

const program = require('commander');

program
  .version('0.1.0')
  .command('rmdir <dir> [otherDirs...]')
  .action(function (dir, otherDirs) {
    console.log('rmdir %s', dir);
    if (otherDirs) {
      otherDirs.forEach(function (oDir) {
        console.log('rmdir %s', oDir);
      });
    }
  });

program.parse(process.argv);

可变参数的值以 数组 的形式传递给操作处理程序。

操作处理程序(Action handler) (子)命令

你可以使用操作处理程序为一个命令增加选项options。 操作处理程序会接收每一个你声明的参数的变量，和一个额外的参数——这个命令对象自己。这个命令的参数包括添加的命令特定选项的值。

const program = require('commander');

program
  .command('rm <dir>')
  .option('-r, --recursive', 'Remove recursively')
  .action(function (dir, cmdObj) {
    console.log('remove ' + dir + (cmdObj.recursive ? ' recursively' : ''))
  })

program.parse(process.argv)

你可以自行实现一个async操作处理程序，同时调用.parseAsync代替.parse。

async function run() { /* 在这里编写代码 */ }

async function main() {
  program
    .command('run')
    .action(run);
  await program.parseAsync(process.argv);
}

当一个命令在命令行上被使用时，它的选项必须是合法的。使用任何未知的选项会报错。

独立的可执行(子)命令

当 .command() 带有描述参数时，不能采用 .action(callback) 来处理子命令，否则会出错。这告诉 Commander，你将采用独立的可执行文件作为子命令。 Commander 将会尝试在入口脚本（例如 ./examples/pm）的目录中搜索 program-command 形式的可执行文件，例如 pm-install, pm-search。 你可以使用配置选项 executableFile 来指定一个自定义的名字

你可以在可执行文件里处理可执行(子)命令的选项，而不必在顶层声明它们

// file: ./examples/pm
const program = require('commander');

program
  .version('0.1.0')
  .command('install [name]', 'install one or more packages')
  .command('search [query]', 'search with optional query')
  .command('update', 'update installed packages', {executableFile: 'myUpdateSubCommand'})
  .command('list', 'list packages installed', {isDefault: true})
  .parse(process.argv);

如果你打算全局安装该命令，请确保可执行文件有对应的权限，例如 755。

自动化帮助信息 help

帮助信息是 commander 基于你的程序自动生成的，默认的帮助选项是-h,--help (样例)。

$ node ./examples/pizza --help
Usage: pizza [options]

一个用于下单订购披萨的应用

Options:
  -V, --version        输出版本号
  -p, --peppers        增加peppers
  -c, --cheese <type>  指定增加特殊种类的cheese (默认: "marble")
  -C, --no-cheese      你不想要任何cheese
  -h, --help           展示命令的帮助信息

如果你的命令中包含了子命令，help命令默认会被添加，它可以单独使用或者通过一个子命令名字来展示子命令的进一步帮助信息。实际上这和有隐式帮助信息的shell程序一样:

shell help
shell --help

shell help spawn
shell spawn --help

自定义帮助

你可以通过监听 --help 来显示额外信息。一旦调用完成(样例)。

program
  .option('-f, --foo', 'enable some foo');

// 必须在.parse()之前
program.on('--help', () => {
  console.log('');
  console.log('Example call:');
  console.log('  $ custom-help --help');
});

生成输出以下的帮助信息

Usage: custom-help [options]

Options:
  -f, --foo   enable some foo
  -h, --help  display help for command

Example call:
  $ custom-help --help

.usage 和 .name

这两个选项让你可以自定义在帮助信息第一行中显示的命令使用描述(description)，并且描述是从（完整的）命令参数中推导出来的。例如：

program
  .name("my-command")
  .usage("[global options] command")

帮助信息会以此开头：

Usage: my-command [global options] command

.help(cb)

输出帮助信息并立即退出。 可选的回调可在显示帮助文本后处理。

.outputHelp(cb)

输出帮助信息的同时不退出。 可选的回调可在显示帮助文本后处理。

.helpInformation()

Get the command help information as a string for processing or displaying yourself. (The text does not include the custom help from --help listeners.)

.helpOption(flags, description)

重写覆盖默认的帮助标识和描述

program
  .helpOption('-e, --HELP', 'read more information');

.addHelpCommand()

你可以使用 .addHelpCommand() 和 .addHelpCommand(false) 明确打开或关闭隐式的帮助命令

你可以提供名字和描述，以同时打并自定义帮助命令:

program.addHelpCommand('assist [command]', 'show assistance');

自定义事件监听

你可以通过监听命令和选项来执行自定义函数。

program.on('option:verbose', function () {
  process.env.VERBOSE = this.verbose;
});

program.on('command:*', function (operands) {
  console.error(`error: unknown command '${operands[0]}'`);
  const availableCommands = program.commands.map(cmd => cmd.name());
  mySuggestBestMatch(operands[0], availableCommands);
  process.exitCode = 1;
});

零碎知识

.parse() 和 .parseAsync()

.parse的第一个参数是要解析的字符串组，你可以省略参数以隐式使用process.argv

如果参数遵循与node不同的约定，你可以在第二个参数中传递from选项：

• 'node': 默认的, argv[0]是应用，argv[1]是要跑的脚本，紧随着的是用户参数
• 'electron': argv[1] 根据electron应用是否打包而变化
• 'user': 来自用户的所有参数

比如:

program.parse(process.argv); // 显式的node约定
program.parse(); // 隐式的，自动监测的electron
program.parse(['-f', 'filename'], { from: 'user' });

避免选项命名冲突

Commander原本和默认的行为是将选项值作为program的属性存储的，并且给操作处理程序(action handler)传递了一个将选项值作为属性存储的command对象。 这样确实使得编程很方便，但是会带来有可能会和Command对象的属性相冲突的缺点。

这里有两种方法来改变着这样的行为，而且我们有可能在将来改变默认的行为

• storeOptionsAsProperties: 是否将选项值作为command对象的属性来存储，亦或者分开地存储(指定 false)并使用.opts()来获得。
• passCommandToAction: 是否把command对象传递给操作处理程序，亦或者仅仅传递这些选项(指定 false)

(样例)

program
  .storeOptionsAsProperties(false)
  .passCommandToAction(false);

program
  .name('my-program-name')
  .option('-n,--name <name>');

program
  .command('show')
  .option('-a,--action <action>')
  .action((options) => {
    console.log(options.action);
  });

program.parse(process.argv);

const programOptions = program.opts();
console.log(programOptions.name);

TypeScript

Commander包里包含 TypeScript 定义文件

如果你使用 ts-node 和独立可执行的字命令编写 .ts 文件, 你需要使用 node 来执行程序以保证正确执行子命令。如：

node -r ts-node/register pm.ts

Node 选项例如 --harmony

你可以采用两种方式启用 --harmony：

• 在子命令脚本中加上 #!/usr/bin/env node --harmony。注意一些系统版本不支持此模式。
• 在指令调用时加上 --harmony 参数，例如 node --harmony examples/pm publish。--harmony 选项在开启子进程时会被保留。

调试独立可执行子命令

一个可执行的子命令作为一个单独的子进程执行

如果你在使用 node inspector的 node -inspect 等命令来调试 可执行命令， 对于生成的子命令，inspector端口递增1。

如果你在使用VSCode来调试可执行子命令，你需要在你的launch.json配置文件里设置"autoAttachChildProcesses": true标识

重载退出(exit)处理

默认情况下，当检测到错误以及打印出帮助信息或版本信息时Commander将调用process.exit方法。你可以重写覆盖这项操作并提供一个可选的回调。默认的实现会抛出一个CommanderError。

重载的回调接受一个包含了 Number类型的exitCode、String类型的code和message 属性的CommanderError。除了对可执行子命令完成的异步处理之外，默认的实现方法会抛出这个错。正常情况下，打印错误信息以及帮助或版本信息不会被重载所影响，因为重载的调用在打印之后。

program.exitOverride();

try {
  program.parse(process.argv);
} catch (err) {
  // 自定义处理...
}

例子

const program = require('commander');

program
  .version('0.1.0')
  .option('-C, --chdir <path>', 'change the working directory')
  .option('-c, --config <path>', 'set config path. defaults to ./deploy.conf')
  .option('-T, --no-tests', 'ignore test hook');

program
  .command('setup [env]')
  .description('run setup commands for all envs')
  .option("-s, --setup_mode [mode]", "Which setup mode to use")
  .action(function(env, options){
    const mode = options.setup_mode || "normal";
    env = env || 'all';
    console.log('setup for %s env(s) with %s mode', env, mode);
  });

program
  .command('exec <cmd>')
  .alias('ex')
  .description('execute the given remote cmd')
  .option("-e, --exec_mode <mode>", "Which exec mode to use")
  .action(function(cmd, options){
    console.log('exec "%s" using %s mode', cmd, options.exec_mode);
  }).on('--help', function() {
    console.log('');
    console.log('Examples:');
    console.log('');
    console.log('  $ deploy exec sequential');
    console.log('  $ deploy exec async');
  });

program.parse(process.argv);

更多的演示 可以在这里找到。

许可证

MIT

支持

Commander 4.x版本现在在Node 8以及更高的版本上得到支持，尽管仍有可能在Node 6版本上工作，但是不再保证相关的测试。 （对于Node版本低于6的情况，建议使用Commander 3.x 或 2.x版本。）

主要的社区支持的免费论坛就在Github上的项目Issues

企业使用Commander

作为Tidelift订阅的一部分现在可用

Commander和数以千计的其他包的维护者在与Tidelift合作，提供对于企业用来构筑应用的开源依赖的商业支持与维护。通过向相关依赖包的维护者支付一定费用，从而帮助企业节省时间，降低风险，改进代码运行情况。了解更多