简介
cli-framework 是一个 JavaScript 的命令行框架，可以帮助我们快速地创建自己的命令行工具。它提供了一些常用的功能，如参数解析、自动 Completer、报告错误等等。
安装
我们可以通过 npm 安装 cli-framework ：
npm install --save-dev cli-framework
使用
创建命令行工具
我们可以通过以下代码，创建一个简单的命令行工具：
const cli = require('cli-framework');
cli.command('hello', 'Say hello', function () {
console.log('Hello World!');
});
cli.parse();上面的代码中，我们定义了一个 hello 命令，并在其中添加了一个回调函数，以便在命令行中运行时输出 Hello World! 。
命令行参数
我们可以通过 option 方法来为命令行添加参数。以下是一个例子：
-- -------------------- ---- ------- ----- --- - ------------------------- -------------------- ---- ------- -------------- ------- --------- ----- ------ ---------------- --------- - ----- ---- - ------------ -- -------- ------------------ ----------- --- ------------
此时，我们就可以在命令行中通过 -n 或 --name 参数，指定要打印的名字：
$ node mycli hello --name=Tom Hello Tom!
子命令
我们可以通过 command 方法来创建子命令。以下是一个例子：
-- -------------------- ---- ------- ----- --- - ------------------------- --------------------- ------- --- ------------- ---------------- ------- -- --- ---------- ------------- -------------- ------ -------- ---- --- -- -------- ---------------- --------- - ----- --- - ----------- -- --------- ---------------------- -- ---------- ---- --- ------ ------ --- ------------
此时，我们就可以通过 deploy prod 的命令来部署我们的应用。同时，我们也可以使用 -t 或 --tag 参数来指定要部署的标签。
Completer
我们可以为命令或参数添加自动 Completions 功能。以下是一个例子：
-- -------------------- ---- ------- ----- --- - ------------------------- -------------------- ---- ------- -------------- ------- --------- ----- ------ ------------------- ------- --------- - -------------- ------- -------- ------------------ -- ------------------------- -- ---------------- --------- - ----- ---- - ------------ -- -------- ------------------ ----------- --- ------------
此时，在命令行工具中，我们可以使用 Tab 键来自动补全后面的参数。
错误处理
cli-framework 通过抛出错误的方式，来处理我们在命令行工具使用过程中出现的错误。以下是一个例子：
-- -------------------- ---- ------- ----- --- - ------------------------- -------------------- ---- ------- ---------------- -- - ----- --- ------------ --------- --- ------------------ ----- - --------------------- ------------- --- ------------
在上面的例子中，我们在 hello 命令的回调函数中，手动抛出了一个错误。并且，我们在 error 方法中，定义了错误的处理逻辑。这样，在命令行工具出现错误时，就会自动调用 error 方法中定义的逻辑。
总结
在本篇文章中，我们学习了如何使用 cli-framework 包来创建自己的命令行工具。通过 option、command、completer 等方法，我们可以方便地定制自己的命令行工具，并且还能通过 error 方法来处理我们在使用命令行工具时遇到的错误。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/73942