开发一个nodejs命令行工具

最近在学习nodejs,在掌握了一些基础知识之后,就想着如何运用它解决一些简单的问题。

代码地址

https://github.com/zhuweileo/gitignore-cmd

目标

平时初始化项目工程的时候,总是需要添加.gitignore文件,我之前总是手动复制粘贴一个写好的模板,虽然也不算麻烦,但是作为懒癌晚期,我连复制粘贴也不愿意,于是我就想用nodejs写一个命令行工具,直接输入一个命令,就在当前文件夹内生成.gitignore文件。其实就是让nodejs帮你复制粘贴。

项目目录

1548755955537.png

主要功能代码

getIgnore.js

var https = require('https');
var fs = require('fs');

var url = 'https://raw.githubusercontent.com/zhuweileo/my-git-ignore/master/.gitignore';

module.exports = function getIgnore(){
  https.get(url, function (res) {
    res.setEncoding('utf8');

    let rawData = '';

    res.on('data', (chunk) => {
      rawData += chunk;
    });
    res.on('end', () => {
      fs.writeFileSync('.gitignore',rawData)
    });
  }).on('error',function (e) {
    console.log(e)
  })
}

实现逻辑很简单:

  • 通过https请求,从我的git仓库中获得.gitignore文件
  • 将获得文件内容写入到当前目录

为什么从远程请求?

这样我每次都可以取到最新的.gitignore文件。一但.gitignore文件更新,不需要更新命令行工具。

package.json

{
  "name": "zw-gi",
  "version": "0.0.1",
  "description": "快速生成gitignore的命令行工具",
  "main": "getIgnore.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "朱维",
  "license": "ISC",
  "bin": {
    "zw-gi": "bin/zw-gi"
  }
}

这里的关键点是bin字段:

 "bin": {
    "zw-gi": "bin/zw-gi"
  }

意思是:当你在命令行中执行zw-gi命令时,nodejs会执行bin/zw-gi文件中的代码

当通过npm install zw-gi -g命令安装你的nodejs命令行工具时,npm会根据这个 bin字段,生成可执行程序。不同的系统生成的可执行程序不同:

  • windows系统:zw-gi.cmd (位于C:\Users{用户名}\AppData\Roaming\npm)
  • linux系统:zw-gi

bin/zw-gi

意思很简单,就是执行我们写的getIgnore函数

#!/usr/bin/env node
var getIgnore = require('../getIgnore')
getIgnore();

发布

这样这个模块就写好了,可以发布到npm上了。

也可以不发布,在package.json文件的同级目录执行npm install . -g安装到本地,自娱自乐。

参考

七天学会NodeJS

Nodejs 开发命令行工具

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

推荐阅读更多精彩内容