如何用nodejs写一个像hap-toolkit那样的命令行工具

当前在移动端开发多个典型问题的系统解决方案中,常常用nodejs来帮助开发一套辅助工具,以便于使用或者调试。

我们在建设应用发布平台(热修复平台)的过程中,即用nodejs开发了一套apub工具(类似于快应用的hap-toolkit工具链),将本地编译输出结果,生成下载链接,以二维码的方式提供扫码下载。

移动开发的一些典型问题(如:热修复问题、H5加速问题),除了应该有高效、核心的系统解决方案,还应该提供方便的工具链,以提升使用及开发效率。

一、如何让npm安装时将此命令安装到系统路径?
在项目的package.json中,创建“bin”这个key, 然后你要声明的命令及加载执行文件的路径,如:


image.png

基中, "apub"就是我的命令名称,“bin/apub”,会在当前项目的bin目录下寻找apub这个文件。当然这里的目录和名字都可你自己定义。
当我执行npm install完成安装后,apub会被安装到系统nodejs的一个bin目录下(这个目录已被声明到$PATH变量),我们就可在命令行中使用它了。

我的项目下bin目录的内容:


image.png

其中bin/apub只是引用相同目录下的index.js:

#!/usr/bin/env node
require('./index.js');

关于package.json文件的更多配置项说明可参考:https://docs.npmjs.com/files/package.json#bin

二、如何解析命令行参数?
这里推荐commander这个解析库,自己去写还是要花很多时间的。这个库提供了非常方便地添加参数并解析的方式。

const program = require('commander')
const chalk = require('chalk')

 program
    .version(require('../package').version, '-v, --version')
    .usage('<command> [options]')

program
    .command('server <file>')
    .description('create http server to allow downloading a file by scanning qr-code')
    .action((name, cmd) => {
        let apubServer = require('../lib/command/server')
        apubServer.onServer(name) // 此处根据传入参数解析结果,将执行转到了onServer这个方法
    })
program.on('--help', () => {
    console.log()
    console.log(`  Run ${chalk.cyan(`apub <command> --help`)} for detailed usage of given command.`)
    console.log()
})

program.parse(process.argv)

文中chalk库,能够对输出到标准输出的文字定制样式。

三、如何将内容生成二维码?
这里用到了qrcode-terminal这个库,将需要供扫码下载的文件,提供局域网内下载服务,将下载链接生成二维码打印即可:

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,370评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • “我成功申请到出国留学的名额了”,电话那头的人说道。我的第一个反应是“很好啊,听说学金融的出国留学,会有更好的发现...
    不歪小姐阅读 727评论 0 1
  • Howtogetasolution? 我们所做的topic,一般有几个阶段: Analysis:分析问题,找到问题...
    hzyido阅读 688评论 0 3
  • 昨天中午,我用巧克力豆泡巧克力水,又放了一些巧克力豆,然后就放到了冰箱里,等着巧克力棒冰完成! 今...
    张瑞格阅读 246评论 0 3