webpack+git開發環境將git中tag自動顯示到web中

問題由來: 系統一般是要顯示版本信息的,可是,這以前作的web都是手動打tag,並手動將web中的version版本更新, 若是能將git中的tag版本信息自動添加到web中那是否是很贊? 有了這個想法天然就要探索一下實現方法了, 翻看了一下.git的文件目錄,發現裏面有個.git\refs\tags目錄,這裏面正是要找的tag信息,

v1.0
v1.1
v1.2
複製代碼

每一個文件裏面記錄着commit 標識,也就是該tag是在哪一個節點上的,這裏咱們暫時不用處理那麼深刻(也許這個功能在別的地方能用到). 那咱們就能夠獲取這些文件名稱,而後再進行遍歷獲得tag編碼最大的那個就行了,(一般tag都是逐漸增大的). 由於用到了webpack,天然在開發和打包的就有node環境,獲取這些文件就須要用node方法,讀取文件列表的方法用到了fs模塊,看代碼

var fs = require("fs");
var path="./.git/refs/tags"; // 相對路徑
var files = fs.readdirSync(path); // 同步版本的readdir , 
console.log(files)
複製代碼

獲取列表的代碼已經給出來了,可是應該放到什麼位置呢? 在本地開發的vue項目中結構以下(react相似),

+---build
│      build.js
│      check-versions.js
│      dev-client.js
│      dev-server.js
│      utils.js
│      vue-loader.conf.js
│      webpack.base.conf.js
│      webpack.dev.conf.js
│      webpack.prod.conf.js
+---config
│      dev.env.js
│      index.js
│      prod.env.js
+---dist
+---src
|   +---assets
|   |   +---css
|   |   +---images
|   |   \---style
|   +---components
|   |   +---BackToTop
|   |   +---ImageCropper
|   |   \---layout
|   +---directive
|   +---pages
|   |   +---error
|   |   +---home
|   |   +---login
|   |   \---webrtc
|   \---service
|       +---api
複製代碼

src目錄和static目錄是代碼路徑,環境不不是node環境,因此就不能放到這裏面,外面還有build文件夾,這裏面就是node環境了,(若是你分析過webpack的配置,就不會對這裏陌生),天然要將上面的代碼放到這裏面,觀察了一下內容,發現應該放到config配置裏面最好,固然你也能夠放到別的地方,在config文件夾下新建tag.js,配置裏面的內容以下

var fs = require("fs")
var merge = require('webpack-merge')
var files = fs.readdirSync('./.git/refs/tags')

var currentTag = Math.max(...files.map(p => parseFloat(p.replace(/v/ig, ''))))
if (currentTag > 0) {
  currentTag = '"' + currentTag + '"';
} else {
  currentTag = '""'; 
}

module.exports = {
  WEB_TAG: currentTag
}
複製代碼

獲取到最大的tag後導出一個對象出去便可,注意這裏面獲取tag時我只取了小數,若是像 v1.2.3這樣的會自動變成1.2,固然想實現其餘方法本身實現一下就能夠了. 導出去以後就須要使用了,導入到config下index.js中使用了

// see http://vuejs-templates.github.io/webpack for documentation.
var path = require('path')
module.exports = {
  build: {
    tag: require('./tag'), //引入tag變量
    env: require('./prod.env'),
    index: path.resolve(__dirname, '../dist/index.html'),
    assetsRoot: path.resolve(__dirname, '../dist'),
    assetsSubDirectory: 'static',
    assetsPublicPath: '/',
    productionSourceMap: false,
    productionGzip: false,
    productionGzipExtensions: ['js', 'css'],
    bundleAnalyzerReport: process.env.npm_config_report
  },
  dev: {
    tag: require('./tag'),//引入tag變量
    env: require('./dev.env'),
    port: 8000,
    autoOpenBrowser: true,
    assetsSubDirectory: 'static',
    assetsPublicPath: '/',
    proxyTable: {
      '/api': {
        target: 'https://www.****.com/, // 接口域名 changeOrigin: true, //是否跨域 pathRewrite: { '^/api': '' //須要rewrite重寫的, } } }, cssSourceMap: false } } 複製代碼

此時在src下的js中還不能獲取到該變量,咱們在開發中常常會用到process這個變量,例如獲取rocess.env.NODE_ENV變量進行dev和prodution環境切換就須要判斷rocess.env.NODE_ENV === 'production'這個, 看到這咱們天然也想用該方法去獲取tag就行了,此時嘗試獲取時並不能獲得咱們的tag值,由於咱們沒在webpack中定義該變量. 在build文件夾下有兩個文件webpack.dev.conf.js和webpack.prod.conf.js,裏面定義了該環境下的變量,將tag變量也進行定義就能夠了,

new webpack.DefinePlugin({
   'process.env': config.dev.env,
   'process.tag': config.dev.tag
}),
複製代碼

ok,此時從新運行webpack後發現咱們子src的config.js文件下已經能夠像訪問process.env同樣訪問process.tag了,至於顯示到web頁面中或用於其餘邏輯就看本身實現了. 這樣每次tag更新發布自動帶上了咱們的tag,好高興啊.

我是wwmin,有問題能夠一塊兒討論,郵箱wwei.min@163.com