为什么要使用cli
在我们的日常开发中应该经常会接触到cli
(Cmmand Line Interface),例如npm, yarn, git
等都是cli
工具,我们可以通过在终端运行 npm install xxx
或者 yarn install xxx
去在自己的工程里引入一个包,也可以通过 git clone
将代码克隆到本地。
cli
工具的存在某些场景下极大地提高了我们日常开发的效率,例如你想要删除一个 size 很大的文件夹,在gui
(用户图形界面)下,可能需要好几分钟,甚至机器性能比较低的会因此卡死,但是如果在cli
下运行,只需一行命令就可以快速删除而不影响你其他的工作。
同时,作为软件开发者来讲,我们有时需要执行一些特殊的操作,这些操作可能是在gui
下无法完成的,那么我们就必须依赖cli
。
如何开发一个cli工具
在日常工作中我们或许会高频地使用cli
工具,那你有没有想过如何去开发一个cli
工具呢?
作为一个前端开发,本文将以 JS 为开发语言,讲述如何开发一个简单的cli
工具。
声明
本文将围绕以下几个讲述如何开发一个简单的cli
工具。
- 环境准备
- 如何配置简单的 cli 命令
- 如何处理参数
- 支持交互
1. 准备
首先,确保你的机器上已经安装了 node 和 npm,没有的可以点击这里进行安装。
然后运行一下命令生成一个 node 工程
mkdir mycli & cd mycli
npm init -y
2. 配置一个简单的命令
此时我们的工程中应该有一个package.json
文件, 在该文件中增加 bin
配置,如下图所示。
其中,mycli
是cli工具的名称,对应的 value 值是文件入口,这里为了便于文件管理,可以新建一个src/
目录,将入口文件index.js
放于该目录下。
编辑index.js
,内容如下:
⚠️第一行很重要,用来指明运行环境
这时我们可以在控制台运行mycli
查看效果
你可能会上述错误,控制台找不到我们的cli
工具,这是因为我们在使用一个工具的时候必须安装它,例如你没有安装npm
的时候去使用也会遇到同样的错误。
由于我们的mycli
并没有发布,因此可以借助npm link
选择本地安装,执行:
npm link
然后再执行mycli
,就可以看到index.js
中的内容打印到控制台了。
3. 处理参数
很多时候我们需要在运行cli
工具时携带参数,那么如何获取到这个参数呢?
在node
程序中,通过process.argv
可获取到命令的参数,以数组返回.
这里以-h
为例,我们可以先打印一下修改process.argv
,看下它是如何存储参数的
可以看到数组的第三个元素即我们想要的参数,返回修改index.js
在控制台运行mycli -h
注:这里我们只是做一个简单的示例,故采用这种方式处理参数,真实项目中参数和处理方式可能会更复杂一些,不建议用上述方式,可以采用路由的方式
4. 控制台交互
有的时候我们可能需要在命令行工具中融入一些交互,根据用户的输入生成一些东西或者做相应的操作。
这里引入一个npm
的包 --- inquirer
这个包基本包含了我们可能用到的交互类型,例如input
、list、confirm等,可以轻松地帮我们实现控制台的简单交互。
如何使用这个包及语法参照上面的链接,不再赘述。
在示例代码中我们设定了两个问题:
- 询问用户的姓名
- 选择最喜欢的水果
并将用户的回答打印到控制台。
示例代码 执行结果 返回用户输入的数据尾声
本文只是讲述了一个简单的cli
工具的开发,在实际运用中可能会结合需求借助一些工具进行开发。
下一篇将讲述如何使用 yeoman-generator + cli
工具生成一个脚手架。
感兴趣的欢迎围观。
参考资料:
网友评论