npm 是前端开发中不可或缺的工具，可以让我们轻松安装和管理各种模块和库。其中，yargs-command-config 是一个方便的 npm 包，可以帮助我们快速构建命令行工具。本文将详细介绍如何使用 yargs-command-config，包括安装、配置、使用和示例等。
安装
首先，我们需要在本地项目中安装 yargs-command-config。可以使用以下命令完成安装：
npm install yargs yargs-command-config --save
安装完成后，我们就可以开始配置和使用了。
配置
yargs-command-config 提供了一些配置选项，可以通过命令行参数或配置文件来加载和使用。下面是一些常见的配置选项：
$schema：用来指定配置文件的 JSON Schema，方便编辑和校验配置文件的正确性。defaults：配置默认选项和参数，可以覆盖命令行参数和配置文件中的值。envPrefix：设置一个前缀来读取环境变量，比如MY_APP_。commandDir：指定命令文件所在的目录路径。strict：开启严格模式，非法参数将导致错误。
除了以上选项，yargs-command-config 还提供了许多其他高级选项和扩展功能，可以根据需要进行配置。
使用
配置完成后，我们就可以开始使用 yargs-command-config 来构建命令行工具了。比如，我们可以创建一个 CLI 工具来生成随机数。步骤如下：
1. 创建命令文件
首先，需要创建一个命令文件，命名为 generate.js，并保存在命令目录中。命令文件需要导出一个函数，用来处理命令和参数。比如，我们可以这样创建一个生成随机数的命令：
-- -------------------- ---- -------
----- ------ - -------------------------
-------------- - ------- -- -
--------------------- ----- ------- --------- - ------ -------- --- ------ -- -
----- - ---- --- - - -----
----- ------ - ----------- -----
------------------- ------- ------------
---
--这个命令可以通过 random 命令生成一个指定范围内的随机数，比如：
node my-cli.js random 1 100
2. 加载命令文件
接下来，在启动 CLI 工具的文件中，需要加载命令文件和 yargs-command-config。比如，我们可以这样创建一个入口文件 my-cli.js：
-- -------------------- ---- -------
-------------- ----
----- ----- - -----------------
----- ------------------ - --------------------------------
------------------------- -
-- -----
--------- -
------- -----------------------
--
---
-- ------
-------------------------------
-- ----
--------------这个文件首先加载了 yargs 和 yargs-command-config，然后配置了一些默认选项和参数（比如，加载配置文件），接着加载了 ./commands 目录下的所有命令文件，最后解析参数并执行对应的命令。
3. 配置文件
在上面的代码中，我们使用了 ./my-cli-config.json 配置文件来配置默认选项和参数，比如：
{
"random": {
"min": 1,
"max": 100
}
}这样，我们就可以通过以下命令来生成一个随机数了：
node my-cli.js random
示例
在本节中，我们将通过一个完整的示例来演示如何使用 yargs-command-config 来构建命令行工具。我们假设需要开发一个名为 my-cli 的 CLI 工具，可以执行以下命令：
my-cli hello <name>：向指定的名字打招呼。my-cli random <min> <max>：生成一个指定范围内的随机数。my-cli add：将指定的数字相加。
步骤如下：
1. 创建项目
首先，我们需要创建一个 npm 项目，将 yargs 和 yargs-command-config 安装到依赖列表中：
npm init -y npm install yargs yargs-command-config --save
然后，创建一个 src 目录，并在其中创建一个入口文件 index.js 和一个命令目录 commands。
2. 创建命令文件
接着，我们需要在 ./src/commands 目录下创建三个命令文件：hello.js、random.js 和 add.js。代码如下：
hello.js
module.exports = (yargs) => {
yargs.command('hello <name>', 'Say hello to the name', {}, (argv) => {
console.log(`Hello, ${argv.name}!`);
});
};random.js
-- -------------------- ---- -------
----- ------ - -------------------------
-------------- - ------- -- -
--------------------- ----- ------- --------- - ------ -------- --- ------ -- -
----- - ---- --- - - -----
----- ------ - ----------- -----
------------------- ------- ------------
---
--add.js
module.exports = (yargs) => {
yargs.command('add <numbers...>', 'Add numbers', {}, (argv) => {
const { numbers } = argv;
const sum = numbers.reduce((acc, cur) => acc + Number(cur), 0);
console.log(`Sum: ${sum}`);
});
};3. 加载命令文件
然后，在入口文件 index.js 中，我们需要加载 yargs 和 yargs-command-config，并加载 ./src/commands 目录下的所有命令文件。代码如下：
-- -------------------- ---- -------
-------------- ----
----- ----- - -----------------
----- ------------------ - --------------------------------
------------------------- -
--------- -
---------- ----------
------- -----------------------
--
---
-------------------------------
--------------这个文件开启了环境变量前缀 MY_APP_，加载了 ./my-cli-config.json 配置文件，默认情况下将搜索 ./src 和 ./commands 目录中的所有命令文件，并解析参数并执行相应的命令。
4. 配置文件
最后，我们需要在项目目录下创建一个配置文件 my-cli-config.json，用来配置命令行工具的默认选项和参数，比如：
-- -------------------- ---- -------
-
-------- -
------- -------
--
--------- -
------ --
------ ---
-
-这样，当我们执行以下命令时，就可以得到指定的输出：
node my-cli.js hello node my-cli.js hello John node my-cli.js random node my-cli.js random 1 10 node my-cli.js add 1 2 3
总结
本文介绍了如何使用 yargs-command-config 构建命令行工具，并提供了一个完整的示例。通过阅读本文，你应该掌握了 yargs-command-config 的基本用法，包括安装、配置、使用和示例等。希望对你有所帮助，也欢迎进一步学习和探索相关的技术和工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056f7481e8991b448e7a4c