前言
在前端开发中，我们经常需要编写命令行工具（CLI）以及脚本。而npm上的 commander-config 是一个非常好的命令行工具库，可以大大简化我们的 CLI 开发。本文将为大家介绍如何使用 commander-config 中的配置项，进一步提高 CLI 的可用性。
简介
commander-config 看起来很简单，实际上它的使用也很简单。它与 commander 库非常相似，但是有不同的配置选项。
安装
要使用 commander-config，请在终端中运行以下命令来安装：
npm install -g commander-config
使用
在使用 commander-config 之前，需要通过下面的命令在项目的根目录下创建一个 config 文件夹：
mkdir config
创建配置文件
在 config 文件夹中创建一个 JSON 文件，例如：
-- -------------------- ---- -------
-
------ -
-------- ----
----------- ----- -- - --- --------
--
------ -
-------- ----
---------- -------- ----- --- -----
----------- ----- -- - --- --------
-
-以上的配置项表示有两个可选参数，foo 和 bar。其中，foo 可以使用 -f 或 --foo 来传递参数，bar 可以使用 -b 或 --bar 来传递参数，并且 bar 的默认值为 "default value for bar"。
创建 CLI
在项目的 JavaScript 文件中，使用 require 来引入 commander-config，然后调用 createCLI() 函数即可创建 CLI:
const config = require('commander-config').createCLI();此时，我们就创建了一个没有任何参数和命令的 CLI。
配置 CLI
现在我们需要根据我们的需求来配置 CLI。如下所示：
-- -------------------- ---- ------- -- -- ---------------- -- ----- ------ - ---------------------------------------- -- -- --- -- ------ ----------------- ----------------- ----------- ------------------ -- - ---- ---------- -------------- ----- -- --- --- --------- ---------------------
其中，version() 用来设置 CLI 的版本信息，usage() 用来设置 CLI 的用法信息，description() 用来设置 CLI 的描述信息，option() 用来设置 CLI 的参数选项。
读取配置项
根据配置项的名称，可以直接从 config 对象中读取配置项的值。
console.log(config.foo); console.log(config.bar);
以上的输出结果将分别是：
true "default value for bar"
示例代码
总结下来，我们将创建一个很简单的 CLI 来演示使用 commander-config 的方法。
首先创建文件夹和文件：
mkdir cli && cd cli && mkdir config && touch index.js && touch config/options.json
在 config 文件夹中创建 options.json：
-- -------------------- ---- -------
-
------ -
-------- ----
----------- ----- -- - --- --------
--
------ -
-------- ----
---------- -------- ----- --- -----
----------- ----- -- - --- --------
-
-接着，在 index.js 中编写代码：
-- -------------------- ---- ------- -------------- ---- ----- ------ - ---------------------------------------- ------ ----------------- ----------------- ----------- ------------------ -- - ---- ---------- -------------- ----- -- --- --- --------- --------------------- ------------------- ------------ ------------------- ------------
然后在命令行中执行：
npm link
最后在命令行中输入以下命令即可测试：
cli -f -b customBar
输出结果将是：
foo: true bar: 'customBar'
结束语
本文为大家介绍了如何在 CLI 中使用 commander-config，并提供了一个简单的示例。相信本文将对学习和使用 commander-config 有所指导。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/76517