如何在NodeJS中构建CLI工具

2019年04月24日译者：riven

作为开发人员，我们使用 CLI 工具。从 git 到 cloud shells - 我们到处都在使用这些工具。所以，现在是时候做自己的了。我们将在此过程中使用 Heroku 的伟大 oclif 框架。

什么是 oclif 框架？

它是由著名的 Heroku 提供的一个快速构建 CLI 工具的开放框架。

我们列了四项待办：

Oclif 可以生成两种类型的项目——

在本文中，我们需要一个多命令项目，所以让我们生成它：

npx oclif multi todocli

运行此命令并按照说明将初始化当前目录中名为 todocli 的新项目。

现在，让我们进入目录并运行帮助：

cd todocli && ./bin/run --help

打印结果如下：

> USAGE   
    $ todocli [COMMAND]  
  COMMANDS
    hello   
    help   display help for todocli

这显示了可用的命令及其文档。

在 src 目录中，我们可以找到一个名为 commands 的目录。此目录包含所有命令及其相应文件名。例如，如果我们有一个命令 hello，我们将在这个目录中有一个名为 hello.js 的文件，该命令将在没有任何设置的情况下工作。如果我们不需要它，就删除 hello.js。

要存储我们的任务，我们需要一个存储系统。为简单起见，我们将使用 lowdb 这是一个非常简单的 json 文件存储系统。

我们先安装

npm install lowdb --save

让我们在项目根目录中创建一个 db.json 文件。该文件将保存我们的数据。然后我们需要安装 lowdb。现在，我们将在 src 目录中创建一个名为 db.js 的文件。这个文件将保存我们的数据库。

在这里，我们首先简单地加载所需的库和文件，然后将一个空的 todos 数组定义为我们的基本集合（如果你联想一下 SQL 数据库，那它就类似一个表）。

oclif 为我们提供了平滑的命令生成功能。让我们运行以下内容：

oclif command add

这将在 src/commands 目录中创建一个名为 add.js 的文件。让我们用下面的代码替换该文件的内容：该文件有几个关键要素：

./bin/run add --task="welcome task"

此命令将向数据库添加任务并打印该操作的响应。

在 show.js 中，我们以升序显示所有任务。我们用 chalkjs 添加了一点颜色，使我们的命令结果更好看。

为简单起见，我们现在只是为我们的更新部分设置任务。我们只是将任务的 id 作为标志传递。

./bin/run update --id=1

这将为 id = 1 的任务设置 done = true。

删除非常简单：我们将 id 作为标志传递，然后从数据库中删除相关任务。

就这样，我们制作了非常简单的 todocli。现在，如果我们想像使用其他普通的 CLI 工具一样使用它或让我们的朋友使用它，我们需要让它成为一个 npm 包，在 npm 上发布它即可。

首先，确保你有一个 npm 帐户。然后，您需要运行以下命令登录

npm login

然后进入项目目录内运行

npm run prepack

这将打包项目，并将通过描述和标志生成 readme，然后一切准备就绪。

现在，在npm上发布：

npm publish

如果一切顺利，那么该模块已成功发布在 npm 上。如果失败，请检查项目名称和版本。现在，我们可以像使用其他 npm 工具一样全局安装使用它。

npm install -g todocli

然后任何人都可以随时随地使用这些命令。

> todocli add --task="Great task!!!"
> todocli show
> todocli update --id=1
> todocli remove --id=1

感谢阅读我的文章，如果你喜欢请鼓掌，并阅读我的其他文章，如 V8 release v7.3.

FENews 是由一群热爱技术的前端小伙伴自发组成的团队。团队会定期创作和翻译前端相关的技术文章，同时我们也欢迎外部投稿或加入我们的核心编辑团队。如果您对我们感兴趣，请关注我们的公众号：