从0开始用node写一个自己的命令行程序

前言

什么是命令行程序呢?像我们常见的webpack,vue-cli都属于命令行程序。
本文将带你从0开始用node写一个自己的命令行程序,并发布到npm。

准备工作

我打算写一个统计个人代码提交量的命令行工具,起名 git-tool
npm地址见 git-tool,GitHub地址见 git-tool

  1. 在GitHub上新建一个项目git-tool
  2. 克隆到本地进行开发。
  3. 执行npm init创建package.json文件。
// 其他代码
"bin": {
    "git-tool": "./index.js"
},
// 其他代码

bin字段里面的key值可以随便取名,value值为对应的执行文件。

  1. 新建index文件。
#!/usr/bin/env node
console.log('git-tool')

#!/usr/bin/env node的意思是让系统自己去找node的执行程序,该行必不可少。

  1. 执行npm link
    如果执行该命令报错,参考https://docs.npmjs.com/getting-started/fixing-npm-permissio

  2. 运行git-tool
    我们发现控制台会打印出git-tool。

    图一

实现

经过以上步骤我们已经基本搭好环境了,下面就可以开始写自己的逻辑了。

  • 参数读取
    process.argv用来获取命令行参数。
    修改index.js文件

    #!/usr/bin/env node
    console.log('git-tool')
    console.log(process.argv)
    

    然后执行git-tool ss cd,结果如下图所示:

    图二

process.argv返回一个数组,数组前两位是固定的,分别是node程序的路径和脚本存放的位置,从第三位开始才是额外输入的内容。
npm社区有一些优秀的命令行参数解析包,如yargscommander.js
我使用的是commander.js

  • 插件
    commander.js的基本使用很简单,

    #!/usr/bin/env node
    const program = require('commander');
    program.version('1.0.0')
    program
     .command('codeLineNum')
     .description('统计git提交代码量')
     .option("--author [author]", "统计指定作者git提交代码量")
     .action(function (options) {
       console.log(options.author)
     })
    program.parse(process.argv);
    

    此时执行git-tool -h,效果如下:

    图三

它会帮我们自动做一些事情,很方便。

  • 思路
    我们要实现统计代码提交量的目的,就必须借助git命令。
    git log --author="username" --pretty=tformat: --numstat
    该命令输出如下:

    图四

    第一列为增加的代码行数,第二列为删除的代码行数,第三列为改动的文件。
    一些管道命令符可以处理这些数据,但是Windows系统不支持。
    所以我的思路是把数据写到文件中,然后在逐行读取进行处理。

  • 代码
    具体实现细节就不展开了,有兴趣的可以去GitHub看源码。
    最终实现效果如下

    图五
    图六

发布npm包

  1. 创建npm账户(如果已有,略过该步骤)
    注册地址:https://www.npmjs.com/signup
  2. 登陆
    npm login
  3. 发布
    npm publish

每次发布时都需要更改package.json 中的version;
发布需将npm registry地址设为 http://registry.npmjs.org
npm config set registry http://registry.npmjs.org

参考资料

手把手教你使用nodejs编写cli(命令行)
Node.js 命令行程序开发教程-阮一峰

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

推荐阅读更多精彩内容

  • 得益于 Node.js,我们可以使用熟悉的 Javascript 语言来开发跨平台的命令行程序。 图形界面:操作简...
    前端小透明阅读 1,708评论 0 7
  • 描述 npm从以下来源获取配置值,按优先级排序: 命令行标记 在命令行上放置--foo bar设置foo配置参数为...
    竹天亮阅读 44,040评论 0 8
  • 将一维数组传递到方法中。
    5c8e2b8217ae阅读 176评论 0 1
  • 一个人喜欢什么或不喜欢什么,是件非常私人的事情。 有的人喜欢热闹,有的人喜欢安静;有的人喜欢宅在家里,有的人喜欢外...
    对花情味阅读 1,327评论 3 6