Stdio库

在NodeJS中解析命令行参数的最简单方法是使用stdio模块。受UNIX getopt实用程序的启发，它非常简单：

var stdio = require('stdio');
var ops = stdio.getopt({
    'check': {key: 'c', args: 2, description: 'What this option means'},
    'map': {key: 'm', description: 'Another description'},
    'kaka': {args: 1, required: true},
    'ooo': {key: 'o'}
});

如果使用此命令运行前面的代码：

node <your_script.js> -c 23 45 --map -k 23 file1 file2

那么ops对象将如下所示：

{ check: [ '23', '45' ],
  args: [ 'file1', 'file2' ],
  map: true,
  kaka: '23' }

所以你可以随心所欲地使用它。例如：

if (ops.kaka && ops.check) {
    console.log(ops.kaka + ops.check[0]);
}

还支持分组选项，因此您可以编写-om而不是-o-m。

此外，stdio可以自动生成帮助/用法输出。如果调用ops.printHelp（），将得到以下结果：

USAGE: node something.js [--check <ARG1> <ARG2>] [--kaka] [--ooo] [--map]
  -c, --check <ARG1> <ARG2>   What this option means (mandatory)
  -k, --kaka                  (mandatory)
  --map                       Another description
  -o, --ooo

如果未提供强制选项（前面有错误消息）或指定错误（例如，如果为选项指定了一个参数，并且需要2），也会显示上一条消息。

您可以使用NPM安装stdio模块：

npm install stdio

本地实验方法

Nodejs团队在18.3.0和16.17.0版本中添加了util.parseArgs函数。因此，如果您使用这些或更高版本的nodejs，您可以使用本机解决方案解析命令行参数。

文档中的用法示例：

const {parseArgs} = require('node:util');

const args = process.argv;
const options = {
  foo: {
    type: 'boolean',
    short: 'f'
  },
  bar: {
    type: 'string'
  }
};
const {
  values,
  positionals
} = parseArgs({ args, options, allowPositionals: true });

console.log(values);
console.log(positionals);

输出样本：

$ node parseargs.js -f --bar b
[Object: null prototype] { foo: true, bar: 'b' }
[
  '/Users/mbelsky/.nvm/versions/node/v18.12.1/bin/node',
  '/Users/mbelsky/parseargs.js'
]

最初的问题是要求传递命令行参数，而不是更复杂的参数解析。然而，面对所有复杂的答案，他们都错过了一个简单而有用的变化。

你知道Unix shell支持命名参数吗？这可以追溯到20世纪80年代最初的伯恩贝壳。用法很简单：

$ FOO=one BAR=two nodejs myscript.js

要获取Javascript中的参数：

var foo = process.env.FOO;
var bar = process.env.BAR;

一旦超过两个或三个参数，命名参数就更容易读取。可选参数很简单，顺序也不固定。

（这甚至可以在Windows上运行，因为最近支持Unix shell。）

而且，几乎没有Unix程序员知道这种用法

为了像常规javascript函数那样规范化参数，我在node.js shell脚本中执行以下操作：

var args = process.argv.slice(2);

注意，第一个参数通常是nodejs的路径，第二个参数是您正在执行的脚本的位置。

process.argv是您的朋友，在NodeJS中本机支持捕获命令行参数。参见以下示例：

process.argv.forEach((val, index) => {
  console.log(`${index}: ${val}`);
})

我扩展了getArgs函数，只获取命令，以及标志（-f，--anotherflag）和命名的args（--data=blablabla）：

模块

/**
 * @module getArgs.js
 * get command line arguments (commands, named arguments, flags)
 *
 * @see https://stackoverflow.com/a/54098693/1786393
 *
 * @return {Object}
 *
 */
function getArgs () {
  const commands = []
  const args = {}
  process.argv
    .slice(2, process.argv.length)
    .forEach( arg => {
      // long arg
      if (arg.slice(0,2) === '--') {
        const longArg = arg.split('=')
        const longArgFlag = longArg[0].slice(2,longArg[0].length)
        const longArgValue = longArg.length > 1 ? longArg[1] : true
        args[longArgFlag] = longArgValue
     }
     // flags
      else if (arg[0] === '-') {
        const flags = arg.slice(1,arg.length).split('')
        flags.forEach(flag => {
          args[flag] = true
        })
      }
     else {
      // commands
      commands.push(arg)
     } 
    })
  return { args, commands }
}


// test
if (require.main === module) {
  // node getArgs test --dir=examples/getUserName --start=getUserName.askName
  console.log( getArgs() )
}

module.exports = { getArgs }

用法示例：

$ node lib/getArgs test --dir=examples/getUserName --start=getUserName.askName
{
  args: { dir: 'examples/getUserName', start: 'getUserName.askName' },
  commands: [ 'test' ]
}

$ node lib/getArgs --dir=examples/getUserName --start=getUserName.askName test tutorial
{
  args: { dir: 'examples/getUserName', start: 'getUserName.askName' },
  commands: [ 'test', 'tutorial' ]
}