前言
随着前端技术的快速发展和日益复杂的项目需求，JavaScript 的使用已不仅仅局限于浏览器端了。越来越多的前端工程师需要使用 Node.js 开发命令行工具来简化繁琐的操作。而 @cli-engine/engine 就是一个非常优秀的命令行工具开发框架，支持 TypeScript、自动敲打命令、命令行参数验证等一系列功能，本篇文章将为大家详细介绍如何使用这个工具。
什么是 @cli-engine/engine
@cli-engine/engine 是一个基于 Node.js 开发的命令行工具框架，可以轻松构建各种类型的命令行应用程序。其最大的优点是支持 TypeScript，可以使我们更快、更可靠地构建新型的 CLI 工具。
@cli-engine/engine 具有以下特点：
- 支持 TypeScript，提供完善的类型文件
- 支持自动敲打命令和选项
- 提供了全面的命令行参数验证、解析和输出
- 还可以方便地定义命令、选项和标志
下面，我们将通过实例来演示如何使用 @cli-engine/engine 来构建我们自己的 CLI 工具。
安装
首先，我们需要在本地项目中安装 @cli-engine/engine。使用 npm 安装即可。
--- ------- -- ------------------
使用
创建一个新的项目
使用 create 命令来创建一个新的 CLI 工具项目：
---------- ------ -----------
上述命令会在当前目录下创建一个新的名为 hello-world 的项目。
编写命令
打开 src/commands 目录，可以看到一个 hello.ts 的文件，里面已经为我们提供了示例代码。这个示例代码接受一个参数，并向终端输出问候语。
安装依赖
我们需要安装一些必要的依赖来运行我们的 CLI 工具。
在命令行工具根目录下使用 npm 安装：
--- -------
测试运行
运行命令 hello，并传入一个参数，然后就可以看到它向我们打印了一个问候语。
----- --
拓展命令
当我们需要添加更多的命令时，只需要在 src/commands 目录下新建 TypeScript 文件，这个文件应该暴露一个继承了 Command 的类，并在类中定义我们需要实现的命令逻辑。
下面是一个示例的 TypeScript 文件：
------ - -------- ----- - ---- ----------------------
------ ------- ----- --------- ------- ------- -
------ ----------- - ---------
------ ----- - -
---- --------------
------------ -------
--------- -----
---
--
------ ---- - -- ----- ------ ---
----- ----- -
----- - ----- ----- - - ----------------------
----- ---- - --------- -- ---
----- --- - --------- -- ---
----------------- --------------- ----------
-
-在上述代码中，我们可以看到一个新的 MyCommand 类，类名需要与我们的 TypeScript 文件名称保持一致，这样才能被正确加载。同时，我们可以在类中使用 description、flags 和 args 等方法定义新的命令参数，并在 run 方法中编写命令的具体逻辑。
国际化
@cli-engine/engine 支持非常友好的国际化功能，以支持多语言需求。默认情况下，命令行工具将根据本地化环境语言（locale）设置命令行中输出的语言。我们可以通过添加翻译文件来为我们的程序增加更多的语言支持。
在命令行根目录下，新建一个名为 messages.po 的文件，然后在其中添加我们的 i18n 内容：
- -------- ----- -- -- --- ----- -- ------ -- -------------- ----------- ---------------- ------------------ ---------- ----------------- -------------------- --------- ------------------- ---------- -------------- --------------- ---------- ---- --------------------- ---------- -------- -------------- ------ -------------- ------- ----------- -------------- ----------- ------------ ---------------------- --------- --------------------------- -------------- ----- ------- -------- ------ ------------
添加完 i18n 文件后，就可以在 CLI 中使用不同的语言了。
总结
@cli-engine/engine 是一个非常强大、灵活的 Node.js 命令行工具框架，能够为我们快速开发高可用性、易于维护的命令行应用程序提供很大的帮助。它在 TypeScript 的支持上做的非常好，还提供了自动敲打命令和选项、命令行参数验证、解析和输出等一系列方便快捷的功能。在实际应用开发中，我们一定要学会使用这个工具，从而更快地开发出更好的 CLI 工具。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/94305