如何在webpack中獲取git版本和當(dāng)前腳本的工作目錄

僅針對(duì)vue項(xiàng)目,當(dāng)然你如果能看懂也可以繼續(xù)叁温。

前言

前一陣子因?yàn)関ue部署不上去錯(cuò)誤沒(méi)有解決再悼,一直找不到原因,后來(lái)一看部署的git版本有問(wèn)題膝但,于是決定在頁(yè)面中顯示git版本冲九。
要顯示git版本,首先要知道它存在什么地方跟束?這就導(dǎo)致我們需要知道git的目錄中的信息莺奸,知道了信息我們?cè)趺窗阉贸鰜?lái)這也是個(gè)問(wèn)題?冀宴。

準(zhǔn)備工作

.git目錄與git了解

當(dāng)你創(chuàng)建一個(gè)倉(cāng)庫(kù)的時(shí)候灭贷,使用 git init 指令, git 將會(huì)創(chuàng)建一個(gè)神奇的目錄:.git略贮。這個(gè)目錄下包含了所有 git 正常工作所需要的信息甚疟。

這里就是第一次提交之前 .git 目錄的文件結(jié)構(gòu):

├── HEAD:這個(gè)文件包含了一個(gè)檔期分支(branch)的引用,通過(guò)這個(gè)文件Git可以得到下一次commit的parent
├── branches
├── config:這個(gè)是GIt倉(cāng)庫(kù)的配置文件
├── description:倉(cāng)庫(kù)的描述信息逃延,主要給gitweb等git托管系統(tǒng)使用
├── hooks:這個(gè)目錄存放一些shell腳本览妖,可以設(shè)置特定的git命令后觸發(fā)相應(yīng)的腳本;在搭建gitweb系統(tǒng)或其他git托管系統(tǒng)會(huì)經(jīng)常用到hook script
│ ├── pre-commit.sample
│ ├── pre-push.sample
│ └── ...
├── info:包含倉(cāng)庫(kù)的一些信息
│ └── exclude
├── objects:所有的Git對(duì)象都會(huì)存放在這個(gè)目錄中揽祥,對(duì)象的SHA1哈希值的前兩位是文件夾名稱(chēng)讽膏,后38位作為對(duì)象文件名
│ ├── info
│ └── pack
└── refs:這個(gè)目錄一般包括三個(gè)子文件夾,heads拄丰、remotes和tags府树,heads中的文件標(biāo)識(shí)了項(xiàng)目中的各個(gè)分支指向的當(dāng)前commit
├── heads
└── tags

這個(gè)文件包含你倉(cāng)庫(kù)的設(shè)置信息。例如這里會(huì)放你遠(yuǎn)程倉(cāng)庫(kù)的 URL料按,你的 email 地址奄侠,你的用戶名等…。 每次你在控制臺(tái)使用“git config…”指令時(shí)站绪,修改的就是這里遭铺。

這里不對(duì).git的文件進(jìn)行詳細(xì)說(shuō)明了,直接說(shuō)明是那個(gè)文件恢准,這里給大家推薦幾個(gè).git目錄詳解的教程:

git指南:GitBook
探索 .git 目錄魂挂,讓你真正了理解git
Git HEAD 意思詳解 和版本回退
GitBook, Git + Markdown 快速發(fā)布你的書(shū)籍

首先,Git必須知道當(dāng)前版本是哪個(gè)版本馁筐,在Git中涂召,用HEAD表示當(dāng)前分支版本的路徑指向,也就是最新的提交敏沉。這里我們需要用到git根目錄下的HEAD果正,我們打開(kāi)它炎码,他里面有這樣一句話:

ref: refs/heads/這里是你的分支名字

如果你只有master分支或者你通過(guò)git checkout 分支切換到master上,就是ref: refs/heads/master秋泳。

比如題主目前有兩個(gè)分支

我的分支查看

在develop分支時(shí)潦闲,HEAD的內(nèi)容是ref: refs/heads/develop,在master分支時(shí)HEAD的內(nèi)容是ref: refs/heads/master

我們根據(jù)HEAD指向的目錄信息可以看到如下內(nèi)容

HEAD指向的目錄信息

這里說(shuō)明題主是develop分支(如果你們沒(méi)有develop分支迫皱,請(qǐng)打開(kāi)你們自己的當(dāng)前分支版本的路徑指向)歉闰,所以我們打開(kāi)develop,它的內(nèi)容就是當(dāng)前git版本b1b8d7b1f29d40b68c16b2f524d8655ae99faeae(注意我的提交ID和你的肯定不一樣)

node讀取文件

因?yàn)槲覀兪腔趙ebpack的git版本獲取卓起,而webpack是基于node的和敬,因?yàn)槭腔趘ue的前端,我們沒(méi)有辦法在src底下的前端項(xiàng)目中獲取src文件之外的東西(如果你這樣做了戏阅,不過(guò)不是static昼弟,那是不對(duì)的),所以我們只能在src之外的可以使用node的地方奕筐,供我們選擇的地方不多舱痘,只有下面這些:

使用node的地方

我們這里仔細(xì)敲定選通過(guò)config的底下的項(xiàng)目構(gòu)建文件dev.env.jsprod.env.js來(lái)得到我們需要的信息,即在項(xiàng)目構(gòu)建時(shí)我們獲取git版本救欧。

我們需要使用node的fs模塊

這里附上node的api:

Node.js 中文文檔

webpack構(gòu)建時(shí)使用node獲取git版本

默認(rèn)的dev.env.js是這樣的:

var merge = require('webpack-merge')
var prodEnv = require('./prod.env')

module.exports = merge(prodEnv, {
  NODE_ENV: '"development"'
})

默認(rèn)的prod.env.js是這樣的:

module.exports = {
  NODE_ENV: '"production"'
}

我們dev.env.js的獲取代碼如下:(記住題主是develop分支衰粹,你們不一定锣光,但是代碼是相同的笆怠,只是注釋換成你們自己的)

var merge = require('webpack-merge')
var prodEnv = require('./prod.env')

// 當(dāng)前腳本的工作目錄的路徑
var cwd = '"' + process.cwd() + '"' // process-node全局模塊用來(lái)與當(dāng)前進(jìn)程互動(dòng),可以通過(guò)全局變量process訪問(wèn)誊爹,不必使用require命令加載蹬刷。它是一個(gè)EventEmitter對(duì)象的實(shí)例。process.cwd()表示返回運(yùn)行當(dāng)前腳本的工作目錄的路徑

// 獲取git版本
var fs = require("fs")
var gitHEAD = fs.readFileSync('.git/HEAD', 'utf-8').trim() // ref: refs/heads/develop
var ref = gitHEAD.split(': ')[1] // refs/heads/develop
var develop = gitHEAD.split('/')[2] // 環(huán)境:develop
var gitVersion = fs.readFileSync('.git/' + ref, 'utf-8').trim() // git版本號(hào)频丘,例如:6ceb0ab5059d01fd444cf4e78467cc2dd1184a66
var gitCommitVersion = '"' + develop + ': ' + gitVersion + '"' // 例如dev環(huán)境: "develop: 6ceb0ab5059d01fd444cf4e78467cc2dd1184a66"
module.exports = merge(prodEnv, {
  CURRENT_WORK_DIR: cwd, // 當(dāng)前腳本的工作目錄的路徑
  GIT_COMMIT_VERSION: gitCommitVersion, // 獲取git版本
  NODE_ENV: '"development"'
}

注意:上面代碼的'"'東西不能換成'办成,具體原因自行百度。

可是我們dev.env.js只是開(kāi)發(fā)環(huán)境搂漠,我們需要在正式環(huán)境上也顯示迂卢,很簡(jiǎn)單,復(fù)制一份放到prod.env.js中:

// 當(dāng)前腳本的工作目錄的路徑
var cwd = '"' + process.cwd() + '"' // process-node全局模塊用來(lái)與當(dāng)前進(jìn)程互動(dòng)桐汤,可以通過(guò)全局變量process訪問(wèn)而克,不必使用require命令加載。它是一個(gè)EventEmitter對(duì)象的實(shí)例怔毛。process.cwd()表示返回運(yùn)行當(dāng)前腳本的工作目錄的路徑

// 獲取git版本
var fs = require("fs")
var gitHEAD = fs.readFileSync('.git/HEAD', 'utf-8').trim() // ref: refs/heads/develop
var ref = gitHEAD.split(': ')[1] // refs/heads/develop
var develop = gitHEAD.split('/')[2] // 環(huán)境:develop
var gitVersion = fs.readFileSync('.git/' + ref, 'utf-8').trim() // git版本號(hào)员萍,例如:6ceb0ab5059d01fd444cf4e78467cc2dd1184a66
var gitCommitVersion = '"' + develop + ': ' + gitVersion + '"' // 例如dev環(huán)境: "develop: 6ceb0ab5059d01fd444cf4e78467cc2dd1184a66"
module.exports = merge(prodEnv, {
  CURRENT_WORK_DIR: cwd, // 當(dāng)前腳本的工作目錄的路徑
  GIT_COMMIT_VERSION: gitCommitVersion, // 獲取git版本
  NODE_ENV: '"production"'
}

然后我們就可以在別的地方,拿到這些值:例如main.js中

console.log(process.env.CURRENT_WORK_DIR)
console.log(process.env.GIT_COMMIT_VERSION)

結(jié)語(yǔ)

到此我們可以得到git版本還有當(dāng)前腳本的工作目錄的路徑拣度。

提示:后面還有精彩敬請(qǐng)期待碎绎,請(qǐng)大家關(guān)注我的專(zhuān)題:web前端螃壤。如有意見(jiàn)可以進(jìn)行評(píng)論,每一條評(píng)論我都會(huì)認(rèn)真對(duì)待筋帖。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末奸晴,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子日麸,更是在濱河造成了極大的恐慌蚁滋,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,548評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件赘淮,死亡現(xiàn)場(chǎng)離奇詭異辕录,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)梢卸,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,497評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén)走诞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人蛤高,你說(shuō)我怎么就攤上這事蚣旱。” “怎么了戴陡?”我有些...
    開(kāi)封第一講書(shū)人閱讀 167,990評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵塞绿,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我恤批,道長(zhǎng)异吻,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,618評(píng)論 1 296
  • 正文 為了忘掉前任喜庞,我火速辦了婚禮诀浪,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘延都。我一直安慰自己雷猪,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,618評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布晰房。 她就那樣靜靜地躺著求摇,像睡著了一般。 火紅的嫁衣襯著肌膚如雪殊者。 梳的紋絲不亂的頭發(fā)上与境,一...
    開(kāi)封第一講書(shū)人閱讀 52,246評(píng)論 1 308
  • 那天,我揣著相機(jī)與錄音幽污,去河邊找鬼嚷辅。 笑死,一個(gè)胖子當(dāng)著我的面吹牛距误,可吹牛的內(nèi)容都是我干的簸搞。 我是一名探鬼主播扁位,決...
    沈念sama閱讀 40,819評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼趁俊!你這毒婦竟也來(lái)了域仇?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,725評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤寺擂,失蹤者是張志新(化名)和其女友劉穎暇务,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體怔软,經(jīng)...
    沈念sama閱讀 46,268評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡垦细,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,356評(píng)論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了挡逼。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片括改。...
    茶點(diǎn)故事閱讀 40,488評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖家坎,靈堂內(nèi)的尸體忽然破棺而出嘱能,到底是詐尸還是另有隱情,我是刑警寧澤虱疏,帶...
    沈念sama閱讀 36,181評(píng)論 5 350
  • 正文 年R本政府宣布惹骂,位于F島的核電站,受9級(jí)特大地震影響做瞪,放射性物質(zhì)發(fā)生泄漏对粪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,862評(píng)論 3 333
  • 文/蒙蒙 一穿扳、第九天 我趴在偏房一處隱蔽的房頂上張望衩侥。 院中可真熱鬧,春花似錦矛物、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,331評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至屡久,卻和暖如春忆首,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背被环。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,445評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工糙及, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人筛欢。 一個(gè)月前我還...
    沈念sama閱讀 48,897評(píng)論 3 376
  • 正文 我出身青樓浸锨,卻偏偏與公主長(zhǎng)得像唇聘,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子柱搜,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,500評(píng)論 2 359

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

  • git常用命令 GIT常用命令備忘:http://stormzhang.com/git/2014/01/27/gi...
    新篇章閱讀 8,491評(píng)論 1 26
  • 今天有個(gè)人說(shuō)我你朋友圈才兩條朋友圈迟郎,真對(duì)不起朋友圈。 我說(shuō)朋友圈是發(fā)給想發(fā)的人看的聪蘸。他看到了宪肖。任務(wù)就完成了。 同理...
    醉生不夢(mèng)死閱讀 152評(píng)論 0 0
  • 知乎問(wèn)題阱持,沒(méi)有互聯(lián)網(wǎng)的年代,人們是如何查資料的魔熏? 我在2014-12-29 發(fā)現(xiàn)這個(gè)問(wèn)題衷咽。當(dāng)時(shí)我大概已經(jīng)知道了一個(gè)...
    Cyberpunk閱讀 925評(píng)論 0 1
  • Idea ctrl+e 最近打開(kāi)的文件shift+click 關(guān)閉文件alt + q 查看方法聲明ctrl+alt...
    zsj0310閱讀 380評(píng)論 0 0
  • 江城子 - 杏花歌 笙歌奪色春意深, 夜玲瓏蒜绽, 月近人镶骗。 點(diǎn)點(diǎn)花陰, 蒔香潤(rùn)瑤琴躲雅。 花前斗酒第一尊鼎姊, 誰(shuí)為我, 醉...
    錢(qián)塘小泥鰍閱讀 242評(píng)論 0 1