Add branch flag

Author: mawi12345

lib/index.integration.spec.js

@@ -30,7 +30,10 @@ describe('git-revision-webpack-plugin (integration)', function () {
     config.context = targetProject
     config.output.path = targetBuild
     config.plugins = [
-      new GitRevisionPlugin({ gitWorkTree: targetProject })
+      new GitRevisionPlugin({
+        gitWorkTree: targetProject,
+        branch: true
+      })
     ]
 
     webpack(config, function () {
@@ -108,7 +111,11 @@ describe('git-revision-webpack-plugin with lightweightTags option', function ()
     config.context = targetProject
     config.output.path = targetBuild
     config.plugins = [
-      new GitRevisionPlugin({ gitWorkTree: targetProject, lightweightTags: true })
+      new GitRevisionPlugin({
+        gitWorkTree: targetProject,
+        lightweightTags: true,
+        branch: true
+      })
     ]
 
     webpack(config, function () {
@@ -170,3 +177,48 @@ describe('git-revision-webpack-plugin with lightweightTags option', function ()
     })
   })
 })
+
+describe('git-revision-webpack-plugin without branch option', function () {
+  beforeEach(function (done) {
+    fs.emptyDirSync(targetProject)
+    fs.copySync(sourceProject, targetProject)
+
+    fs.emptyDirSync(targetGitRepository)
+    fs.copySync(sourceGitRepository, targetGitRepository)
+
+    fs.remove(targetBuild)
+
+    var config = require(targetProjectConfig)
+
+    config.context = targetProject
+    config.output.path = targetBuild
+    config.plugins = [
+      new GitRevisionPlugin({
+        gitWorkTree: targetProject
+      })
+    ]
+
+    webpack(config, function () {
+      done()
+    })
+  })
+
+  it('should create the VERSION file', function () {
+    var versionPath = path.join(targetBuild, 'VERSION')
+    var VERSION = fs.readFileSync(versionPath)
+
+    expect(VERSION.toString()).to.eql('v1.0.0-1-g9a15b3b')
+  })
+
+  it('should create the COMMITHASH file', function () {
+    var versionPath = path.join(targetBuild, 'COMMITHASH')
+    var COMMITHASH = fs.readFileSync(versionPath)
+
+    expect(COMMITHASH.toString()).to.eql('9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2')
+  })
+
+  it('should not create the BRANCH file', function () {
+    var branchPath = path.join(targetBuild, 'BRANCH')
+    expect(fs.existsSync(branchPath)).to.eql(false)
+  })
+})

lib/index.js

@@ -16,6 +16,8 @@ function GitRevisionPlugin (options) {
   this.versionCommand = options.versionCommand ||
     VERSION_COMMAND + (options.lightweightTags ? ' --tags' : '')
 
+  this.createBranchFile = options.branch || false
+
   this.branchCommand = options.branchCommand ||
     BRANCH_COMMAND
 
@@ -41,13 +43,15 @@ GitRevisionPlugin.prototype.apply = function (compiler) {
     'VERSION'
   )
 
-  buildFile(
-    compiler,
-    this.gitWorkTree,
-    this.branchCommand,
-    /\[git-revision-branch\]/gi,
-    'BRANCH'
-  )
+  if (this.createBranchFile) {
+    buildFile(
+      compiler,
+      this.gitWorkTree,
+      this.branchCommand,
+      /\[git-revision-branch\]/gi,
+      'BRANCH'
+    )
+  }
 }
 
 GitRevisionPlugin.prototype.commithash = function () {

lib/index.spec.js

@@ -79,6 +79,7 @@ describe('git-revision-webpack-plugin (unit)', function () {
       GitRevisionPlugin.__set__('buildFile', buildFile)
 
       new GitRevisionPlugin({
+        branch: true,
         branchCommand: 'custom branch command'
       }).apply()
 
@@ -94,6 +95,7 @@ describe('git-revision-webpack-plugin (unit)', function () {
       GitRevisionPlugin.__set__('runGitCommand', runGitCommand)
 
       new GitRevisionPlugin({
+        branch: true,
         branchCommand: 'custom branch command'
       }).branch()