手把手教你写命令行工具

命令行工具,即 Cli(command-line interface)。是在图形用户界面得到普及之前使用最为广泛的用户界面,它通常不支持鼠标,用户通过键盘输入指令,计算机接收到指令后,予以执行。

在学习这篇教程之前,你需要先了解NodeJs,NPM和一些常用的shell命令!

对于前端开发者来说,用NodeJs开发命令行工具是最方便和快速的,借助于 npm,可以方便的进行调试和发布。

NodeJs的命令行使用如下图所示:


cli截图.png

那么怎么从零开始写一个命令行工具呢?

一、创建一个新项目

首先,我们创建一个npm项目。

$ mkdir cli-demo
$ cd cli-demo
$ npm init

通过以上步骤,我们新建了一个cli-demo文件夹,并且在cli-demo文件夹中初始化了一个package.json文件。package.json的内容大概是这样:

{
  "name": "cli-demo",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "MIT"
}

二、新建一个可执行文件

我们在cli-demo文件夹中,新建一个js文件,这里我们新建一个名为cli.js的文件。

我们在写命令行工具的时候,需要指定一个可执行文件。在package.json中,bin字段用来映射命令名和可执行文件。在通过npm install -g全局安装的时候,npm会symlink可执行文件到prefix/bin文件夹。
如果通过npm install本地安装的时候, npm会symlink可执行文件到./node_modules/.bin/文件夹。

(完整的字段说明在这里:https://docs.npmjs.com/files/package.json)

如何让一个js文件变成可执行文件?只需要在js文件的头部加上一行代码:

#!/usr/bin/env node

稍微完善一下cli.js, 如下:

#!/usr/bin/env node

console.log('Hello world!');

三、指定cli.js为执行文件

我们需要在package.json中,指定bin字段将cli.js作为我们的执行文件。

{
  "bin": "cli.js"
}

或者:

{
  "bin": {
    "cli-demo": "cli.js"
  }
}

四、调试

我们全局安装一个cli包后,可以全局调用这个命令行工具。那我们在开发调试的时候, 就要用到npm link这个命令了。

在npm包文件夹下执行npm link命令,会创建一个符号链接,链接全局文件夹{prefix}/lib/node_modules/<package>和你执行npm link的包文件夹。

注意:package-namepackage.json中的name, 而不是文件夹名。

详细的解释在这儿: https://docs.npmjs.com/cli/link

我们在cli-demo文件夹下执行npm link命令后,就可以全局使用cli-demo命令了。

$ cli-demo

Hello world!

五、使用命令行辅助工具

在我们写命令行工具的时候,使用一些辅助工具会让我们开发更高效。以下是一些我用过的一些辅助工具:

修改我们的cli.js,使用Commander.js做一些更复杂的操作。

首先,安装commander.js:

npm i commander

cli.js代码:

#!/usr/bin/env node

const program = require('commander');

program
  .version('0.1.0')
  .option('-n, --yourname [yourname]', 'Your name')
  .option('-g, --glad', 'Tell us you are happy')
  .parse(process.argv);

if (program.yourname) {
  console.log(`Hello, ${program.yourname}! ${program.glad ? 'I am very happy to see you!' : ''}`);
}

在命令行中使用:

$ cli-demo -h

  Usage: cli-demo [options]

  Options:

    -V, --version              output the version number
    -n, --yourname [yourname]  Your name
    -g, --glad                 Tell us you are happy
    -h, --help                 output usage information
$ cli-demo -n Jay

  Hello, Jay!
$ cli-demo -n Jay -g

  Hello, Jay! I am very happy to see you!

六、发布

单纯的发布包到npm非常简单,只需要一条命令:

npm publish

但是一个完善规范的发布流程不仅如此,还需要考虑版本号的规范(Semver),commit message的规范,tag等一系列因素。如果手动来搞的话,是挺麻烦的。

这里推荐使用relix, 一步搞定!

npm i relix -g

进入cli-demo文件夹,然后:

relix --patch

会自动帮你生成新版本号,生成提交信息,打tag,推送提交和tag到github,发布npm包!relix的详细用法请看relix文档。

我的Github: https://github.com/PengJiyuan

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

推荐阅读更多精彩内容