Commander-JS的强制性参数

时间:2019-06-04 16:30:50

标签: javascript node.js command-line-interface node-commander

我想知道是否可以在commander上创建如下所示的命令

toggle (on|off) <args...>

(on|off)表示您必须选择一种或另一种强制性的产品。

理想情况下,指挥官应注意抛出适当的错误和错误消息。

1 个答案:

答案 0 :(得分:1)

正如@shadowspawn所说,指挥官不支持这种构造。但是,您可以通过将必需参数作为参数来模拟它,然后自己进行验证。然后,您可以使用用法来覆盖帮助输出。这样的事情。

const assertOnOff = (str) => {
  if (!/^(on|off)$/.test(str)) {
    Logger.error('Toggle action must be either `on` or `off`');
    process.exit(1);
  }
};

const expandJson = str => JSON.stringify(JSON.parse(str), null, 2);

async function start(action, features) {
  assertOnOff(action);
  // ... do things
}


program.command('toggle <action> <FEATURE_NAME...>')
  .description('turns a feature on or off')
  .usage('(on|off) <FEATURE_NAME...>')
  .action(start);

然后当您这样调用命令

toggle -h

您将获得此帮助输出

Usage: toggle (on|off) <FEATURE_NAME...>

turns a feature on or off

Options:
  -i, --institution [name]  Institution name
  -h, --help                output usage information