開發(fā)一個(gè)nodejs命令行工具

最近在學(xué)習(xí)nodejs熬荆,在掌握了一些基礎(chǔ)知識之后杖挣,就想著如何運(yùn)用它解決一些簡單的問題。

代碼地址

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

目標(biāo)

平時(shí)初始化項(xiàng)目工程的時(shí)候献幔,總是需要添加.gitignore文件负甸,我之前總是手動(dòng)復(fù)制粘貼一個(gè)寫好的模板,雖然也不算麻煩慎玖,但是作為懶癌晚期贮尖,我連復(fù)制粘貼也不愿意,于是我就想用nodejs寫一個(gè)命令行工具趁怔,直接輸入一個(gè)命令湿硝,就在當(dāng)前文件夾內(nèi)生成.gitignore文件。其實(shí)就是讓nodejs幫你復(fù)制粘貼润努。

項(xiàng)目目錄

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)
  })
}

實(shí)現(xiàn)邏輯很簡單:

  • 通過https請求关斜,從我的git倉庫中獲得.gitignore文件
  • 將獲得文件內(nèi)容寫入到當(dāng)前目錄

為什么從遠(yuǎn)程請求?

這樣我每次都可以取到最新的.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"
  }
}

這里的關(guān)鍵點(diǎn)是bin字段:

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

意思是:當(dāng)你在命令行中執(zhí)行zw-gi命令時(shí)鳍侣,nodejs會執(zhí)行bin/zw-gi文件中的代碼

當(dāng)通過npm install zw-gi -g命令安裝你的nodejs命令行工具時(shí)丁稀,npm會根據(jù)這個(gè) bin字段,生成可執(zhí)行程序倚聚。不同的系統(tǒng)生成的可執(zhí)行程序不同:

  • windows系統(tǒng):zw-gi.cmd (位于C:\Users{用戶名}\AppData\Roaming\npm)
  • linux系統(tǒng):zw-gi

bin/zw-gi

意思很簡單二驰,就是執(zhí)行我們寫的getIgnore函數(shù)

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

發(fā)布

這樣這個(gè)模塊就寫好了,可以發(fā)布到npm上了秉沼。

也可以不發(fā)布桶雀,在package.json文件的同級目錄執(zhí)行npm install . -g安裝到本地,自娛自樂唬复。

參考

七天學(xué)會NodeJS

Nodejs 開發(fā)命令行工具

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末矗积,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子敞咧,更是在濱河造成了極大的恐慌棘捣,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,214評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件休建,死亡現(xiàn)場離奇詭異乍恐,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)测砂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評論 2 382
  • 文/潘曉璐 我一進(jìn)店門茵烈,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人砌些,你說我怎么就攤上這事呜投〖有伲” “怎么了?”我有些...
    開封第一講書人閱讀 152,543評論 0 341
  • 文/不壞的土叔 我叫張陵仑荐,是天一觀的道長雕拼。 經(jīng)常有香客問我,道長粘招,這世上最難降的妖魔是什么啥寇? 我笑而不...
    開封第一講書人閱讀 55,221評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮洒扎,結(jié)果婚禮上示姿,老公的妹妹穿的比我還像新娘。我一直安慰自己逊笆,他們只是感情好栈戳,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著难裆,像睡著了一般子檀。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上乃戈,一...
    開封第一講書人閱讀 49,007評論 1 284
  • 那天褂痰,我揣著相機(jī)與錄音,去河邊找鬼症虑。 笑死缩歪,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的谍憔。 我是一名探鬼主播匪蝙,決...
    沈念sama閱讀 38,313評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼习贫!你這毒婦竟也來了逛球?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,956評論 0 259
  • 序言:老撾萬榮一對情侶失蹤苫昌,失蹤者是張志新(化名)和其女友劉穎颤绕,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體祟身,經(jīng)...
    沈念sama閱讀 43,441評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡奥务,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了袜硫。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片氯葬。...
    茶點(diǎn)故事閱讀 38,018評論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖父款,靈堂內(nèi)的尸體忽然破棺而出溢谤,到底是詐尸還是另有隱情,我是刑警寧澤憨攒,帶...
    沈念sama閱讀 33,685評論 4 322
  • 正文 年R本政府宣布世杀,位于F島的核電站,受9級特大地震影響肝集,放射性物質(zhì)發(fā)生泄漏瞻坝。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評論 3 307
  • 文/蒙蒙 一杏瞻、第九天 我趴在偏房一處隱蔽的房頂上張望所刀。 院中可真熱鬧,春花似錦捞挥、人聲如沸浮创。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽斩披。三九已至,卻和暖如春讹俊,著一層夾襖步出監(jiān)牢的瞬間垦沉,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評論 1 261
  • 我被黑心中介騙來泰國打工仍劈, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留厕倍,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,467評論 2 352
  • 正文 我出身青樓贩疙,卻偏偏與公主長得像讹弯,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子这溅,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評論 2 345

推薦閱讀更多精彩內(nèi)容