在前端开发中，我们经常需要编写命令行工具来完成一些自动化的任务。而解析命令行参数是命令行工具中的一个重要组成部分。本文介绍一个 npm 包 @kssfilo/getopt，它提供了一个简单易用的命令行参数解析器。
安装 @kssfilo/getopt
@kssfilo/getopt 是一个 npm 包，可以使用 npm 命令来安装：
npm i @kssfilo/getopt
使用 @kssfilo/getopt
基本用法
@kssfilo/getopt 的基本用法非常简单。我们只需要创建一个 getopt 实例，并为其设置选项和参数即可。下面是一个简单的例子：
-- -------------------- ---- ------- ----- ------ - --------------------------- ----- ------- - --------------- ------ --------- ------------------- ------ ------------ --- ----- ---- - ------------------------------------- ------------------
在上面的例子中，我们使用 getopt.create 方法创建一个 getopt 实例，并为其指定两个选项：'-f/--file' 和 '-v/--verbose'。'-f/--file' 选项需要一个参数，'-v/--verbose' 选项不需要参数。
然后我们调用 getopt 实例的 parse 方法，并将原始参数数组作为参数传入。parse 方法返回一个对象，其中包含了选项和参数的详细信息。
在上面的例子中，如果我们使用以下命令行参数来运行程序：
node example.js -f config.json --verbose
则程序将输出以下内容：
{ options: { file: 'config.json', verbose: true }, params: [] }选项类型
除了 NEED_PARAM 类型之外，@kssfilo/getopt 还支持 NO_PARAM 和 MULTI_PARAM 两种选项类型。
NO_PARAM 选项表示该选项不需要参数。例如，'-v/--verbose' 选项在上面的例子中就是一个 NO_PARAM 选项。
MULTI_PARAM 选项则表示该选项需要多个参数。例如，'-d/--debug' 选项需要两个参数，一个是调试级别，一个是调试文件名。使用下面的代码可以设置一个 MULTI_PARAM 类型的选项：
const options = getopt.create([ ['-d', '--debug', getopt.MULTI_PARAM] ]);
缺省选项值
有时候我们希望在用户没有指定某个选项时，使用一个缺省值来代替。@kssfilo/getopt 支持在创建 getopt 实例时为选项指定缺省值。例如：
const options = getopt.create([ ['-f', '--file', getopt.NEED_PARAM, 'config.json'] ]);
在上面的例子中，如果用户没有指定文件名，则默认使用 'config.json'。
短选项合并
有些命令行工具允许用户将多个短选项合并使用。例如，如果一个工具有'-a'、'-b'和'-c'三个选项，用户可以将它们写成'-abc'的形式。@kssfilo/getopt 也支持这种用法。只需要在 getopt.create 方法中将 'a'、'b' 和 'c' 三个选项设置为同一个数组即可：
const options = getopt.create([ ['-abc', '', getopt.NO_PARAM] ]);
参数集合
除了选项之外，命令行工具通常还需要接受一些参数。@kssfilo/getopt 也支持解析参数。解析出来的参数将存储在 parse 方法返回的结果对象的 params 属性中。例如：
const options = getopt.create([]); const args = options.parse(process.argv.slice(2)); console.log(args.params);
在上面的例子中，如果我们使用以下命令行参数来运行程序：
node example.js foo bar
则程序将输出以下内容：
['foo', 'bar']
错误处理
在解析命令行参数的过程中，有可能会出现错误的情况。例如，当用户传递了一个不支持的选项时，就应该抛出一个异常。@kssfilo/getopt 提供了两种方式来处理错误。
一种方式是让 getopt.parse 方法直接抛出异常。如果需要使用这种方式，需要在 getopt.create 方法中传入一个名为 'raiseException' 的参数，将它的值设置为 true。
另外一种方式是使用 getopt.hasError 方法来检查是否有错误。如果有错误，getopt.hasError 方法将返回一个非空字符串。例如：
-- -------------------- ---- ------- ----- ------- - --------------- ------ --------- ------------------ --- ----- ---- - ------------------------------------- -- -------------------- - ---------------------------------- ---------------- -
总结
本文介绍了 @kssfilo/getopt 这个简单易用的命令行参数解析器。我们可以使用它快速编写出一个优秀的命令行工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067357890c4f7277583ce8