在前端开发中，我们经常需要编写一些命令行工具或脚本，这时候我们就需要解析命令行参数。在 Node.js 生态中，有很多用于解析命令行参数的库，get-options 就是其中之一。get-options 是一个轻量级的 npm 包，用于解析命令行参数。
安装
使用 npm 安装 get-options：
npm install get-options
使用
get-options 的用法非常简单，首先需要定义一个选项对象，选项对象指定了你的程序需要处理的所有选项和它们的默认值。例如：
-- -------------------- ---- -------
----- ---- - -
----- - -- ------ ---- ---
------ ---- -- ------ -
----- ---------- -- ------------
------------ ----- ----- -- ----
--
-------- - -- ------ ------- ---
------ ----
----- ----------
------------ ----- --------
--
----- -
------ ----
----- ---------
-------- --------
------------ ----- -----
-
--然后，通过调用 getOptions 函数，并将选项对象传递给它来解析命令行参数。例如：
-- -------------------- ---- ------- ----- - -------- ---- - - ----------------------------- -- -------------- - -- --------- - -- ----------------- - -- -------- - ------------------- -------------------
当运行上面的脚本时，如果没有任何参数，将输出 Hello, World! 如果请求帮助，则输出帮助信息；如果请求版本，则输出版本号。
CLI 参数
get-options 默认从 process.argv 解析命令行选项。 process.argv 包括 Node.js 进程的命令行参数：
process.argv[0]：Node.js 可执行文件的完整路径。process.argv[1]：当前执行的文件的路径。process.argv[n]：在命令行中传递的其他参数。例如，如果运行node app.js -h -n Kate，process.argv[2]是-h，process.argv[3]是-n，process.argv[4]是Kate。
示例
让我们看一个更完整的示例，在此示例中，我们将使用 get-options 来构建一个简单的命令行工具，用于计算两个数字的总和。
首先，我们需要在命令行中检索两个数字，并将它们存储在变量中。
-- -------------------- ---- -------
----- - -------- ---- - - ------------------------
-- -
------ ----
----- ---------
------------ ---- ----- -------
--
-- -
------ ----
----- ---------
-------- --
------------ ---- ------ -------
-
---
----- - - --------- -- --------
----- - - --------- -- ------- -- --
----------------- - ---- - --- - -----接下来，运行脚本：
node add.js 1 2
输出：
1 + 2 = 3
如果只提供一个数字，则默认第二个数字为 0，如下所示：
node add.js 3
输出：
3 + 0 = 3
选项
get-options 的选项对象包括以下属性：
alias
选项的别名。
const opts = {
a: {
alias: 'aaa',
...
}
};default
选项的默认值。如果选项没有设置，则使用默认值。
const opts = {
x: {
default: 0,
...
}
};description
选项的描述信息。
const opts = {
x: {
description: 'The first number',
...
}
};type
选项的类型。支持以下类型：
boolean：布尔类型（true 或 false）。number：数值类型。string：字符串类型。
const opts = {
x: {
type: 'number',
...
}
};required
选项是否为必需项。如果设置为 true，则必须设置该选项。
const opts = {
x: {
required: true,
...
}
};总结
通过学习 get-options 的使用方法，我们可以快速、方便地解析命令行参数，为我们开发命令行工具带来了很大的便利性。希望此篇文章可以帮助你理解 get-options 的使用方法，从而使你更加快速高效的开发出命令行工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a730d09270238225c9