介绍
accomplish 是一个简单而强大的 npm 包，专为前端开发者提供优秀交互式命令行体验而设计。使用这个包可以轻松地创建出各种类型的 CLI 应用程序，而不需要深入了解底层的命令行处理。本文将向你介绍如何使用 accomplish 创建自己的 CLI 工具。我们将从安装包、创建命令以及使用与共享配置等方面进行详细讲解。
安装
安装 accomplish 有两种方式：在本地文件中安装或全局安装。你可以根据你的需求选择其中的一种。
本地安装
在你的项目文件夹中安装 accomplish：
npm install accomplish
yarn add accomplish
全局安装
使用下面的命令在全局范围内安装 accomplish：
npm install -g accomplish
yarn global add accomplish
创建命令
我们将以一个示例 CLI 工具为基础，假设你正在构建一个名为 mycli 的 CLI 工具。为了创建一个新的命令，你需要：
- 新建一个
commands文件夹 - 添加一个新文件，文件名就是你想要的命令名称，例如
command1.js - 在该文件中编写一些代码
下面是一个简单的示例命令：
-- -------------------- ---- -------
----- - ------- - - ----------------------
----- ------- - --- ----------
----------------------------
------------------------- ------ --- ----------
--------------------
-
------ ---- ------ ----------
------------ -- ------ ----------
------------- -------- ------
--
-
------ ---- ------------
------------ -- ------- ---------
-
---
--------------------------- -- -
--------------------- -- - ----- -------- -------- ---- -
---
-------------- - --------通过上面的代码，你定义了一个名为 command1 的新命令。该命令使用两个选项进行配置：一个字符串参数 arg1，一个布尔参数 boolArg。
运行 CLI 工具
为了查看 CLI 工具的命令列表，请在终端中运行 mycli，这将输出如下的列表：
Usage: mycli [options] [command] Options: -h, --help display help for command Commands: command1 A simple CLI command help [command] display help for command
你可以看到你刚刚添加的新命令 mycli command1，以及内置的 mycli help 命令。
接下来，运行一下新加的命令：mycli command1 --arg1 value --bool-arg。这将输出 command1 命令的输出，即选择的选项。
使用与共享配置
可以在单个命令中设置自定义选项，但是可以选择将配置移动到共享配置中。
创建一个名为 config.js 的新文件，并在其中编写以下代码：
-- -------------------- ---- -------
----- - ------------- - - ----------------------
----- ------ - --- ----------------
-------------------
-
------ ---- -----------
------------ -------- -------
-
---
-------------- - -------然后，在 commands/command1.js 中，你可以添加如下的代码引入共享配置：
-- -------------------- ---- -------
----- - ------- - - ----------------------
----- ------ - ---------------------
----- ------- - --- ----------
----------------------------
------------------------- ------ --- ----------
--------------------
-----------------------
-
------ ---- ------ ----------
------------ -- ------ ----------
------------- -------- ------
--
-
------ ---- ------------
------------ -- ------- ---------
-
---
--------------------------- -- -
--------------------- -- - ----- -------- -------- ----- -------- ---- -
---
-------------- - --------在上面的代码中，通过引入 ../config，来使用写在 config.js 中的共享配置。
这是使用 accomplish 包创建命令行工具的起步示例。你可以根据你的需求创建适合你的命令。
结论
accomplish 是一个强大而灵活的 npm 包，可以让你轻松地构建出一系列类型的 CLI 工具。通过本文介绍的简单步骤和示例代码，你可以开始创建自己的 CLI 工具，快速实现自己的愿景。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005611a81e8991b448df32c