如何开发一个cli工具

为什么要使用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工具。

  1. 环境准备
  2. 如何配置简单的 cli 命令
  3. 如何处理参数
  4. 支持交互

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工具生成一个脚手架。

感兴趣的欢迎围观。

参考资料:

http://developer.51cto.com/art/201906/597672.htm

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354