介绍
在日常的前端开发工作中，我们有时需要通过命令行来执行一些任务，比如构建项目、运行测试等等。而 interactive-command 就是一个方便的 npm 包，它可以帮助我们创建一个交互式命令行，让我们以更友好的方式来执行这些任务。在本文中，我们将学习如何使用 interactive-command，从而提高我们的开发效率。
安装
首先，我们需要先安装 interactive-command。在终端中执行以下命令：
npm install --save interactive-command
使用
下面我们来学习如何使用 interactive-command。假设我们需要创建一个命令行工具，用来执行一些任务。我们可以在项目中创建一个 index.js 文件，并添加以下代码：
-- -------------------- ---- ------- ----- - ------- - - ------------------------------- ----- ------- - --- ------------------- --------------------------- -- -- - ------------------ -------------- --- -------------------------- -- -- - -------------------- ----------- --- --------------
接下来，我们运行以下命令：
node index.js
执行完毕后，我们会看到以下输出：
? my-tool >
这意味着我们已经成功创建了一个交互式命令行。
接下来，我们可以在命令行中输入以下命令：
? my-tool > build
此时，我们会看到以下输出：
Build successful! ? my-tool >
同样，我们也可以执行以下命令：
? my-tool > test
此时，我们会看到以下输出：
Running tests... ? my-tool >
看起来很简单，对吧？
指南
下面，我们来看一些更深入的内容。
命令的参数
有时我们需要给命令传递一些参数。 interactive-command 也支持这个功能。
我们可以在项目中安装 commander 包，它可以帮助我们解析命令的参数。在终端中执行以下命令：
npm install --save commander
接着修改 index.js 中的代码：
-- -------------------- ---- ------- ----- - ------- - - ------------------------------- ----- ------- - --------------------- ----- -------- - ------------ ------- ---------------------- --------- --- -------- ---------------- --------------------- ----- ------- - --- ------------------- --------------------------- -- ------- -- -- - ------------------ ----------- -- ------ ------ ----------------------- --- ---------------------
然后我们可以在终端中执行以下命令：
node index.js build --my-option=value
此时，我们将得到以下输出：
Build successful! My option value: value ? my-tool >
命令的提示符
我们可以通过传递一个参数来设置命令的提示符。默认情况下，提示符为问号（?）。例如，我们可以用以下代码来将提示符改为“>”：
const command = new Command('my-tool', '>');之后我们运行工具，将看到以下输出：
>
命令的执行链
有时，我们的命令可能需要按照一定的顺序来执行。 interactive-command 提供了一个方法让我们定义命令的执行链。
例如，我们可以使用以下代码来让 build 命令在 test 命令之后执行：
-- -------------------- ---- -------
----- ------- - --- -------------------
-------------------------- -- -- -
-------------------- -----------
---
--------------------------- -
------ ---------
---- -- -- -
------------------ --------------
-
---
--------------这将输出以下内容：
? my-tool > test Running tests... ? my-tool > build Build successful! ? my-tool >
注意，在 build 命令中我们使用了一个对象来进行更细粒度的控制。其中，after 属性指示该命令需要在哪些命令之后执行，而 run 属性则指定了该命令的执行函数。
我们还可以使用 before 属性来让命令在指定命令之前执行。
命令的嵌套
我们也可以通过嵌套命令来构建更复杂的工具。
例如，我们可以使用以下代码来创建一个名为 group 的命令，它包含了两个子命令：build 和 test：
-- -------------------- ---- ------- ----- ------- - --- ------------------- ----- ----- - --- ----------------- ------------------------ -- -- - -------------------- ----- ----------- --- ------------------------- -- -- - --------------------- ----------- --- --------------------------- ------- --------------
然后我们可以在终端中执行以下命令：
node index.js group test
输出结果为：
Running group tests... ? my-tool >
需要退出
有时，我们需要在命令执行过程中退出工具。 interactive-command 提供了一个方法来允许我们这样做。
例如，我们可以使用以下代码让 Build 命令执行成功后退出工具：
-- -------------------- ---- -------
----- ------- - --- -------------------
--------------------------- -
---- -- ---- -- -- -
------------------ --------------
-------
-
---
--------------接着我们运行工具，将得到以下输出：
? my-tool > build Build successful!
给命令添加描述
我们还可以给命令添加一个描述。这样，当用户通过 help 命令查看工具信息时，就可以知道每个命令的作用了。
使用以下代码来添加描述：
-- -------------------- ---- -------
----- ------- - --- -------------------
--------------------------- -
---- -- ---- -- -- -
------------------ --------------
-------
--
------------ ------ ---- -------------
---
--------------然后我们在命令行中执行以下命令：
node index.js help
将得到以下输出：
Commands: build Build this application. ? my-tool >
使用底部信息
最后，我们还可以使用 interactive-command 的底部信息功能。通过传递一个参数，我们可以在命令行的底部显示一些信息。这对于显示版权信息或者工具版本非常有用。
我们可以使用以下代码来添加底部信息：
const command = new Command('my-tool', null, {
version: '1.0.0',
footer: 'Copyright © 2021'
});
command.run();然后我们在命令行中执行以下命令：
node index.js --version
将得到以下输出：
1.0.0
使用以下代码来显示底部信息：
const command = new Command('my-tool', null, {
version: '1.0.0',
footer: 'Custom footer message'
});
command.run();此时我们将得到以下输出：
? my-tool > help
Usage: my-tool [options] [command]
Commands:
help Display help
version Display version结论
通过本文，我们学会了如何使用 interactive-command npm 包来创建一个交互式命令行工具。我们学习了很多有用的技巧，例如定义命令的执行链、嵌套命令、以及添加底部信息等等。这些技巧都将帮助我们更加高效地管理我们的工具，并提高我们的开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a230d09270238223d1