具有可选+可变参数的Node.js命令

时间:2017-10-30 19:16:50

标签: node.js node-commander

我正在试图让节点的commander模块按照我想要的方式解析参数。

我希望将文件列表上传到指定的数据库。有一个默认的数据库名称,因此用户不应 包含数据库参数。

我希望此命令可以如下工作:

>>> ./upload.js --db ReallyCoolDB /files/uploadMe1.txt /files/uploadMe2.txt
(uploads "uploadMe1.txt" and "uploadMe2.txt" to database "ReallyCoolDB")

>>> ./upload.js /files/uploadMe1.txt /files/uploadMe2.txt
(uploads "uploadMe1.txt" and "uploadMe2.txt" to the default database)

>>> ./upload.js --db ReallyCoolDB
(returns an error; no files provided)

如何使用commander实现此功能?我已经尝试了很多东西,目前我仍然坚持使用这段不起作用的代码:

// upload.js:

#!/usr/bin/env node

var program = require('commander');
program
  .version('0.1.0')
  .description('Upload files to a database')
  .command('<path1> [morePaths...]')
  .option('-d, --db [dbName]', 'Optional name of db', null)
  .action(function(path1, morePaths) {

    // At this point I simply want:
    // 1) a String "dbName" var
    // 2) an Array "paths" containing all the paths the user provided
    var dbName = program.db || getDefaultDBName();
    var paths = [ path1 ].concat(morePaths || []);
    console.log(dbName, paths);

    // ... do the upload ...

  })
  .parse(process.argv);

当我尝试运行./upload.js时,我没有输出!

如何使用commander接受单个可选参数和非空字符串列表?

编辑:感谢Rob Raisch的回答,我已经解决了我的问题!解决方案是使用usage而不是action,在program命令之后(而不是在action函数内)执行所有工作,使用program.dbprogram.args,并手动确保program.args非空:

var program = require('commander');

program
    .version('0.1.0')
    .description('Upload files to a database')
    .usage('[options] <path1> [morePaths ...]') // This improves "--help" output
    .option('-d, --db [dbName]', 'Optional name of db', null)
    .parse(process.argv);

var dbName = program.db || getDefaultDBName();
var paths = program.args;

if (!paths.length) {
    console.log('Need to provide at least one path.');
    process.exit(1);
}

// Do the upload!

1 个答案:

答案 0 :(得分:0)

commander命令行处理模块的README.md文件在第二段中回答了您的用例:

“带有命令的选项是使用.option()方法定义的,也用作选项的文档。下面的示例解析来自process.argv的args和选项,将剩余的args保留为program.args 未被选项消耗的数组。“