minimist是nodejs的命令行参数解析工具,因其简单好用,轻量等特性,所以用户使用较多。
特性:
- short options
- long options
- Boolean 和 Number类型的自动转化
- option alias
先看一下minimist整体的解析过程,代码大致是:
or (var i = 0; i < args.length; i++) {
var arg = args[i];
if (/^--.+=/.test(arg)) {
...
} else if (/^--no-.+/.test(arg)) {
...
} else if (/^--.+/.test(arg)) {
...
} else if (/^-[^-]+/.test(arg)) {
...
} else {
...
}
}
解析过程中,minimist会依次匹配不同的模式,从long options到short options,匹配之后再进行相应的解析工作。
使用方式:
var parseArgs = require('minimist');
var startParams = parseArgs(argv,opts={})
opts的参数:
opts.string :字符串或字符串参数名称数组,始终视为字符串
opts.boolean:一个布尔值,字符串或字符串数组,始终视为布尔值。if true会将没有等号的所有双连字符参数视为布尔值(例如,影响--foo,不是-f或--foo=bar)
opts.alias:将字符串名称映射到字符串或字符串参数名称数组以将其用作别名的对象
opts.default:将字符串参数名称映射为默认值的对象
Example:
const startParams = require('minimist')(process.argv.slice(2),{
string : ['port', 'language' ],//key=port|language返回的就是value的字符串
boolean: ['debug'],//debug参数的value有就对应ture,无就对应false
alias: {
port: 'p',//port在解析的时候,会对应返回的是p
language: 'l',
},
default: {
NODE_ENV: 'dev'//默认设置的值
}
})
console.log(process.argv.slice(2))
console.log("----------------------");
console.log(startParams);
启动命令:
D:\StudeyCode\myStudy\myappWx> node .\src\config\index.js --debug=Enble --out=22 --port=3030 --language=cn
输出结果
[ '--debug=Enble', '--out=22', '--port=3030', '--language=cn' ]
----------------------
{ _: [],
debug: 'Enble',
out: 22,
port: '3030',
p: '3030',
language: 'cn',
l: 'cn',
NODE_ENV: 'dev' }