介绍
@oclif/command 是一个用于创建命令行工具的 Node.js 包。它提供了一个用于编写命令和控制台输出的框架。此外，它还提供了一些有用的功能，例如命令行参数解析和验证、命令行帮助信息和颜色输出。在本文中，我们将详细介绍如何使用 @oclif/command 创建自己的命令行应用程序。
安装
要开始使用 @oclif/command，首先需要在项目中安装它。可以使用下面的命令来安装它：
npm install @oclif/command --save
编写命令
下面的代码演示了如何编写一个简单的 command。这个 command 的作用是输出 "Hello, world!" 至控制台。
-- -------------------- ---- -------
-- ---------------------
------ - ------- - ---- -----------------
------ ------- ----- ----- ------- ------- -
------ ----------- - --- ------- ---------
----- ----- -
---------------- ---------
-
-在命令行界面运行命令:
$ node src/hello.js Hello, world!
添加命令行参数
现在，我们将演示如何添加一个参数到命令中。我们将创建一个名为 "greet" 的参数，它将允许用户为命令提供一个字符串来代替 "world"。
-- -------------------- ---- -------
------ - -------- ----- - ---- -----------------
------ ------- ----- ----- ------- ------- -
------ ----------- - --- ------- ---------
------ ----- - -
------ --------------
----- ----
-------- --------
------------ -----------
---
--
----- ----- -
----- - ----- - - ------------------
----- ---- - ------------
---------------- -----------
-
-在命令行中，我们可以这样运行命令：
$ node src/hello.js --greet='Tom' Hello, Tom!
这个命令将输出 "Hello, Tom!"。
添加选项
现在，我们将演示如何添加一个选项到命令中。我们将创建一个名为 "loud" 的选项，它将允许用户将输出变为大写。
-- -------------------- ---- -------
------ - -------- ----- - ---- -----------------
------ ------- ----- ----- ------- ------- -
------ ----------- - --- ------- ---------------------
------ ----- - -
------ --------------
----- ----
-------- --------
------------ -----------
---
----- ---------------
----- ----
-------- ------
------------ ------------
---
--
----- ----- -
----- - ----- - - ------------------
----- ---- - ------------
----- ---- - -----------
----- -------- - ------- ----------
-- ------ -
---------------------------------
- ---- -
-------------------
-
-
-现在，我们可以这样运行命令:
$ node src/hello.js --greet='Tom' --loud HELLO, TOM!
这个命令将输出 "HELLO, TOM!"。
命令行帮助信息
命令行工具通常需要一个命令行帮助信息。@oclif/command 提供了一个简单的方法来定义帮助信息，只需为每个 command 定义一个帮助文本即可。下面的代码演示了如何为 "Hello" command 添加帮助信息：
-- -------------------- ---- -------
------ - -------- ----- - ---- -----------------
------ ------- ----- ----- ------- ------- -
------ ----------- - --- ------- ---------------------
------ ----- - -
------ --------------
----- ----
-------- --------
------------ -----------
---
----- ---------------
----- ----
-------- ------
------------ ------------
---
--
----- ----- -
----- - ----- - - ------------------
----- ---- - ------------
----- ---- - -----------
----- -------- - ------- ----------
-- ------ -
---------------------------------
- ---- -
-------------------
-
-
------ -------- - -
-- ----- -------------
-- ----- ----------- --------
--
-总结
@oclif/command 可以让我们很容易地创建命令行工具并添加参数、选项和帮助信息。这个包虽然减少了一些重复性工作，但它同样提供了一个底层的 API，我们也能利用这个 API 来处理高级的任务。在这个 tutorial 中，我们仅仅局限于一个简单的入门指南，更多的细节和设置是需要我们深入学习的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/89575