在前端开发中，我们经常使用各种第三方库或工具来提高开发效率和代码质量。npm 是其中一个非常流行的包管理工具，它能够让我们方便地下载安装各种 npm 包。今天我们来介绍一个非常好用的 npm 包，它的名字叫做 opted。
opted 是一个用于解析命令行参数的工具包。它支持解析命令行参数以及处理命令行选项和参数值的各种场景，可以帮助我们快速搭建命令行工具。本篇文章将详细介绍 opted 的使用方法，并附上示例代码和实用技巧。
安装 opted
使用 npm 可以很方便地安装 opted：
npm install opted --save
使用 opted
解析命令行参数
opted 最基本的功能就是解析命令行参数。我们可以通过调用 opted.parse() 方法来解析传入的命令行参数：
const opted = require('opted');
const args = process.argv.slice(2);
const options = opted.parse(args);
console.log(options);opted.parse() 方法的返回值是一个对象，包含解析后的所有命令行选项和参数值。例如，如果我们在浏览器中执行上面的代码并传入以下命令行参数：
http-server -p 3000 ./public/
则解析后的结果为：
{
_: ['./public/'],
p: '3000'
}注意，解析出的对象中 _ 属性是一个数组，包含所有未被解析的命令行参数和选项。上面的例子中，_ 属性就包含了 http-server 命令。
定义命令行选项
opted 支持定义各种命令行选项，并根据参数类型自动转换参数值。例如，我们可以定义一个 --port 选项来指定 HTTP 服务器监听的端口号：
-- -------------------- ---- -------
----- ------- - ---------------
----- -
----- ---------
------ ----
------------- -----
------------ ----- ---- -- ------ ----
-------------- -----
--
---opted.options() 方法接收一个选项对象，该对象包括了所有要定义的选项以及对应的参数。在上面的例子中，我们定义了一个名为 port 的选项，它包括了以下属性：
type：选项的参数类型。支持的类型包括string、number、boolean、array等。alias：选项的简写形式。可以不设置。defaultValue：选项的默认值。如果未输入该选项，则会取该选项的默认值。description：选项的描述信息。该信息将在命令行帮助信息中显示。requiresValue：选项是否需要指定参数值。如果需要，则该属性要设置为true。
检查参数有效性
opted 还提供了一些功能强大的方法，可以检查命令行参数是否符合要求并进行相应的处理。
检查必选参数
我们经常需要检查命令行选项或参数是否已被输入。例如，我们在 CLI 工具中可能需要检查用户是否已指定输入文件的路径。使用 opted 可以很方便地实现这个功能。
首先，我们可以将所有必选参数和选项定义在一个数组中：
const requiredOptions = [
{ name: 'src', requiresValue: true },
{ name: 'dest', requiresValue: true },
];然后调用 opted.checkRequired() 方法检查必选参数是否已被输入：
opted.checkRequired(args, requiredOptions, (option) => {
console.error(`Missing required option "${option.name}"`);
process.exit(1);
});opted.checkRequired() 方法接收三个参数：要检查的参数数组、必选参数和选项的数组以及检查不通过时的回调函数。如果必选参数未被输入，则会触发回调函数。
参数值验证
opted 还支持自定义验证选项值的方法。例如，我们可以验证用户输入的端口号是否符合规范：
-- -------------------- ---- -------
----- ------- - ---------------
----- -
----- ---------
------ ----
------------- -----
------------ ----- ---- -- ------ ----
-------------- -----
--------- ------- -- -
-- ------ - ---- -- ----- - ------ -
----- --- ----------- ------ ------ -- ------ ---- -- --------
-
--
--
---在上面的例子中，我们为 port 选项添加了一个 validate 方法，该方法会在解析参数时对参数值进行验证。如果验证不通过，则会抛出错误信息。
帮助信息
最后，我们还可以为命令行工具添加帮助信息。opted 提供了一个 --help 选项，可以打印出详细的帮助信息。
我们可以通过调用 opted.options() 方法中的 help 属性来设置帮助信息。例如：
-- -------------------- ---- -------
----- ------- - ---------------
----- -
----- ---------
------ ----
------------- -----
------------ ----- ---- -- ------ ----
-------------- -----
--
----- -
------ ----
------------ ------ ---- ---- ---------
--
---
-- -------------- -
---------------------------------
----------------
-在上面的例子中，我们定义了一个 help 选项，它没有参数值。如果用户输入了 --help 或 -h 选项，则会打印出帮助信息并退出程序。opted.help() 方法接收一个选项对象，返回格式化后的帮助信息字符串。
总结
以上就是 opted 的基本用法和一些实用技巧。opted 提供了很多方便的 API，可以帮助我们快速搭建命令行工具。希望读者可以在实际开发中得到帮助。如果想了解更多关于 opted 的细节，可以访问官方文档。
参考资料
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67304