使用 Commander 写自己的 Nodejs 命令
共 2231字,需浏览 5分钟
·
2021-06-10 11:26
commander 是一个轻巧的 nodejs 模块,提供了用户命令行输入和参数解析强大功能。
安装
npm install commander
声明 program 变量
为简化使用,Commander 提供了一个全局对象。本文档的示例代码均按此方法使用:
const { program } = require('commander');
program.version('0.0.1');
如果程序较为复杂,用户需要以多种方式来使用 Commander,如单元测试等。创建本地 Command 对象是一种更好的方式:
const { Command } = require('commander');
const program = new Command();
program.version('0.0.1');
选项
Commander 使用 .option()
方法来定义选项,同时可以附加选项的简介。每个选项可以定义一个短选项名称(-后面接单个字符)和一个长选项名称(--后面接一个或多个单词),使用逗号、空格或|分隔。
选项可以通过在 Command 对象上调用 .opts()
方法来获取。对于多个单词的长选项,使用驼峰法获取,例如 --template-engine
选项通过 program.opts().templateEngine
获取。
多个短选项可以合并简写,其中最后一个选项可以附加参数。例如,-a -b -p 80
也可以写为 -ab -p80
,甚至进一步简化为 -abp80
。
--可以标记选项的结束,后续的参数均不会被命令解释,可以正常使用。
默认情况下,选项在命令行中的顺序不固定,一个选项可以在其他参数之前或之后指定。
常用选项类型,boolean 型选项和带参数选项。
有两种最常用的选项,一类是 boolean 型选项,选项无需配置参数,另一类选项则可以设置参数(使用尖括号声明在该选项后,如 --expect <value>
)。如果在命令行中不指定具体的选项及参数,则会被定义为 undefined。
示例代码:options-common.js
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);
const options = program.opts();
if (options.debug) console.log(options);
console.log('pizza details:');
if (options.small) console.log('- small pizza size');
if (options.pizzaType) console.log(`- ${options.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.args
数组中。该方法的参数是可选的,默认值为 process.argv
。
选项的默认值
选项可以设置一个默认值。
示例代码:options-defaults.js
program
.option('-c, --cheese <type>', 'add the specified type of cheese', 'blue');
program.parse();
console.log(`cheese: ${program.opts().cheese}`);
测试命令
pizza-options
cheese: blue
pizza-options --cheese stilton
cheese: stilton