前言
在开发前端项目的过程中，我们经常需要处理来自用户或者配置文件的选项。而选项处理是一个相对繁琐且固定的过程，为了能够更加高效地完成这些任务，我们需要使用一些开源工具来帮助我们完成工作。
其中，optionry 就是一个非常优秀的 npm 包。它可以帮助我们快速地读取和解析命令行参数、环境变量和配置文件等多种数据源，从而减少我们的代码量和开发难度。
在本文中，我们将会介绍 optionry 的使用方法，从安装到具体代码实现，为您全面理解这个 npm 包提供帮助。
安装
在使用 optionry 前，你需要先在你的项目中安装这个 npm 包。你可以使用 npm 或者 yarn 来安装它：
# 使用 npm npm install optionry # 使用 yarn yarn add optionry
基本使用
定义选项
在使用 optionry 之前，我们需要先定义我们的选项。在 optionry 中，选项分为两种类型：单值选项和多值选项。
单值选项表示我们只需要输入一次选项，而多值选项可以接受多个输入。比如说，我们可能需要输入一个类似 --name=yourname 的单值选项，或者一个像 --files=file1.txt,file2.txt,file3.txt 的多值选项。
我们可以使用 optionry 中提供的 API 来定义我们的选项。比如说，下面的代码段展示了如何定义一个叫做 --name 的单值选项：
const Optionry = require('optionry');
const optionry = new Optionry();
optionry.createOption('--name', {
type: 'string',
description: 'the name of the user',
});在上面的代码中，我们首先导入了 optionry 的依赖包，在实例化 Optionry 对象之后，我们使用 createOption 方法定义了一个叫 --name 的选项，同时指定了选项的类型为 string。在这里我们还可以增加选项的说明（description）。
当我们定义完我们的选项之后，我们可以使用 getOption 方法获取特定的选项：
const nameOption = optionry.getOption('--name');这个操作会返回一个包含选项属性的对象。在本例子中，我们可以使用 nameOption.description 属性来获取选项描述。
读取选项
在我们定义了选项之后，我们就需要学习如何从各个数据源中读取和解析这些选项。
在 optionry 中，我们提供了三种默认的数据源，分别是命令行参数（command line arguments）、环境变量（environment variables）和配置文件（configuration file）。我们可以使用 getOptionValue 方法来从这些数据源中获取我们定义好的选项值。
比如说，下面的代码展示了如何读取一个我们定义的 --name 选项：
-- -------------------- ---- ------- ----- -------- - --- ----------- ------------------------------- - ----- --------- ------------ ---- ---- -- --- ------ --- ----- -------- - ---------------------------------- ------------------- --------------
如果我们在命令行执行 node index.js --name=Jack，那么控制台将会输出 Hello, Jack。在这里，我们使用了 getOptionValue 方法读取了我们定义的 --name 选项，并将其值存入 userName 变量中。然后我们使用了 console.log 方法，将 Hello, Jack 输出到控制台。
其他使用方式
在实际的开发中，我们可能使用的数据源并不应该只限于选项。Optionry 也提供了一些 API，可以帮助我们读取和解析其他数据源，比如文件和 stdin 等。你可以查看 官方文档 来获取详细的使用方法。
高级功能
约束行为
Optionry 不仅提供了简单的选项解析，还可以帮助你定义选项的行为约束。比如说，通过配置 isRequired 属性，我们可以要求用户必须输入某个选项，否则我们将抛出错误。另外，我们还可以通过配置参数的类型，来限制用户输入的选项类型。具体配置可以看下面的代码示例：
-- -------------------- ---- -------
----- -------- - --- -----------
------------------------------- -
----- ----------
------------- -----
------------ ---- ---- -- ------ ----
------------ -
----------- -----
-------- -
---- --
---- ------
--
--
---在上面的代码中，我们定义了一个叫做 --port 的整型选项，它的默认值为 8080，必须被输入，且取值范围在 1 到 65536 之间。
自定义类型
假设我们需要定义一个非标准的选项类型，比如 IP 地址，Optionry 可以通过自定义类型的方式来帮助我们解决问题。具体来说，我们只需要定义一个验证函数，并指定它的类型名称，即可在后续使用这个名称代指我们自定义的选项类型。
下面的代码展示了如何定义一个叫做 ip 的自定义选项类型：
-- -------------------- ---- ------- ----- -------- - --- ----------- --------------------------- ------- -- - ----- ----- - -------------------------- ------ ------------------ --- ----------------------------- - ----- ----- ------------ ---- -- ------- -- --- -------- ---
在上面的代码中，我们使用 registerType API 来注册一个叫做 ip 的新的选项类型，并指定了一个验证函数。这个验证函数仅仅是检测传入的值是否满足 xxx.xxx.xxx.xxx 的 IPv4 地址格式。然后，我们使用 createOption API 创建了一个新的选项 --ip，并将其类型设置为之前我们新定义的 ip 选项类型。
解析多值选项
最后，我们来解析一个比较复杂的例子。假设我们需要支持一组文件选项，其格式为类似 --file=file1,file2,file3 的形式。在这种情况下，我们需要使用 optionry 的 array 选项类型。
-- -------------------- ---- ------- ----- -------- - --- ----------- ------------------------------- - -------- ------- ----- -------- ------------- --- ------------ -- ---- -- ------- --- ----- ----- - ---------------------------------- ---------------- ----- --- --------------- ------
在上面的代码中，我们首先定义了一个 --file 的多值选项，其默认值为空数组，且强制要求用户在输入时输入该选项。通过 getOptionValue 方法获取该多值选项值后，我们可以简单地使用 join 函数来将其格式化成字符串。
总的来说，Optionry 是一个非常优秀的 npm 包，能够帮助我们处理各种选项的输入、解析以及约束。希望这篇文章能够对大家在前端开发中使用 optionry 提供帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006725e3660cf7123b363eb