Merge pull request #6 from RomiC/master

pirelenito · web-flow · commit c54d5adb1d12 · 2016-08-04T14:17:05.000+02:00
Lightweight tags support
diff --git a/README.md b/README.md
@@ -39,6 +39,18 @@ And a `COMMITHASH` such as:
 7c16d8b1abeced419c14eb9908baeb4229ac0542
 ```
 
+If you need lightweight tags support, you may turn on `lighweithTags` option in this way:
+
+```javascript
+var GitRevisionPlugin = require('git-revision-webpack-plugin')
+
+module.exports = {
+  plugins: [
+    new GitRevisionPlugin({lightweightTags: true})
+  ]
+}
+```
+
 ### Path Substitutions
 
 It is also possible to use two [path substituitions](http://webpack.github.io/docs/configuration.html#output-filename) on build to get either the revision or version as part of output paths.
diff --git a/fixtures/git-repository/config b/fixtures/git-repository/config
@@ -5,3 +5,5 @@
 	logallrefupdates = true
 	ignorecase = true
 	precomposeunicode = true
+[receive]
+	denyCurrentBranch = ignore
diff --git a/fixtures/git-repository/logs/HEAD b/fixtures/git-repository/logs/HEAD
@@ -1 +1,2 @@
 0000000000000000000000000000000000000000 10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 Paulo Ragonha <paulo@ragonha.me> 1463076183 +0200	commit (initial): dummy project
+10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2 Roman Charugin <cr@redmadrobot.com> 1469887902 +0300	push
diff --git a/fixtures/git-repository/logs/refs/heads/master b/fixtures/git-repository/logs/refs/heads/master
@@ -1 +1,2 @@
 0000000000000000000000000000000000000000 10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 Paulo Ragonha <paulo@ragonha.me> 1463076183 +0200	commit (initial): dummy project
+10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2 Roman Charugin <cr@redmadrobot.com> 1469887902 +0300	push
diff --git a/fixtures/git-repository/objects/5d/badea5413ba2800bd41f336c8bea1335399b2a b/fixtures/git-repository/objects/5d/badea5413ba2800bd41f336c8bea1335399b2a
diff --git a/fixtures/git-repository/objects/9a/15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2 b/fixtures/git-repository/objects/9a/15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2
diff --git a/fixtures/git-repository/objects/d2/270f29e9817ef0bbd680f0596da51d67b16907 b/fixtures/git-repository/objects/d2/270f29e9817ef0bbd680f0596da51d67b16907
diff --git a/fixtures/git-repository/refs/heads/master b/fixtures/git-repository/refs/heads/master
@@ -1 +1 @@
-10e1ff4c17ad1f12241b5c4d9a708a76e98289d8
+9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2
diff --git a/fixtures/git-repository/refs/tags/v2.0.0-beta b/fixtures/git-repository/refs/tags/v2.0.0-beta
@@ -0,0 +1 @@
+9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2
diff --git a/lib/index.js b/lib/index.js
@@ -6,19 +6,20 @@ var versionCommand = 'describe --always'
 
 function GitRevisionPlugin (options) {
   this.gitWorkTree = options && options.gitWorkTree
+  this.lightweightTags = options && options.lightweightTags || false
 }
 
 GitRevisionPlugin.prototype.apply = function (compiler) {
   buildFile(compiler, this.gitWorkTree, commithashCommand, /\[git-revision-hash\]/gi, 'COMMITHASH')
-  buildFile(compiler, this.gitWorkTree, versionCommand, /\[git-revision-version\]/gi, 'VERSION')
+  buildFile(compiler, this.gitWorkTree, versionCommand + (this.lightweightTags ? ' --tags' : ''), /\[git-revision-version\]/gi, 'VERSION')
 }
 
 GitRevisionPlugin.prototype.commithash = function (callback) {
   return runGitCommand(this.gitWorkTree, commithashCommand)
 }
 
 GitRevisionPlugin.prototype.version = function (callback) {
-  return runGitCommand(this.gitWorkTree, versionCommand)
+  return runGitCommand(this.gitWorkTree, versionCommand + (this.lightweightTags ? ' --tags' : ''))
 }
 
 module.exports = GitRevisionPlugin
diff --git a/lib/index.spec.js b/lib/index.spec.js
@@ -42,27 +42,27 @@ describe('git-revision-webpack-plugin', function () {
     var versionPath = path.join(targetBuild, 'VERSION')
     var VERSION = fs.readFileSync(versionPath)
 
-    expect(VERSION.toString()).to.eql('v1.0.0')
+    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('10e1ff4c17ad1f12241b5c4d9a708a76e98289d8')
+    expect(COMMITHASH.toString()).to.eql('9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2')
   })
 
   describe('[git-revision-version] and [git-revision-hash] templates', function () {
     it('should support templates in the output.filename', function () {
-      var versionPath = path.join(targetBuild, 'main-v1.0.0.js')
+      var versionPath = path.join(targetBuild, 'main-v1.0.0-1-g9a15b3b.js')
       fs.readFileSync(versionPath)
     })
 
     it('should support setting the public path', function () {
-      var versionPath = path.join(targetBuild, 'main-v1.0.0.js')
+      var versionPath = path.join(targetBuild, 'main-v1.0.0-1-g9a15b3b.js')
       var mainJs = fs.readFileSync(versionPath)
 
-      var expectedPublicPath = '__webpack_require__.p = "http://cdn.com/assets/v1.0.0/10e1ff4c17ad1f12241b5c4d9a708a76e98289d8";'
+      var expectedPublicPath = '__webpack_require__.p = "http://cdn.com/assets/v1.0.0-1-g9a15b3b/9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2";'
 
       expect(mainJs.indexOf(expectedPublicPath) !== -1).to.eql(true)
     })
@@ -71,12 +71,79 @@ describe('git-revision-webpack-plugin', function () {
   describe('public API', () => {
     it('should expose the commithash', () => {
       var plugin = new GitRevisionPlugin({ gitWorkTree: targetProject })
-      expect(plugin.commithash()).to.eql('10e1ff4c17ad1f12241b5c4d9a708a76e98289d8')
+      expect(plugin.commithash()).to.eql('9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2')
     })
 
     it('should expose the version', () => {
       var plugin = new GitRevisionPlugin({ gitWorkTree: targetProject })
-      expect(plugin.version()).to.eql('v1.0.0')
+      expect(plugin.version()).to.eql('v1.0.0-1-g9a15b3b')
     })
   })
 })
+
+describe('git-revision-webpack-plugin with lightweightTags 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, lightweightTags: true })
+    ]
+
+    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('v2.0.0-beta')
+  })
+
+  it('should create the COMMITHASH file', function () {
+    var versionPath = path.join(targetBuild, 'COMMITHASH')
+    var COMMITHASH = fs.readFileSync(versionPath)
+
+    expect(COMMITHASH.toString()).to.eql('9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2')
+  })
+
+  describe('[git-revision-version] and [git-revision-hash] templates', function () {
+    it('should support templates in the output.filename', function () {
+      var versionPath = path.join(targetBuild, 'main-v2.0.0-beta.js')
+      fs.readFileSync(versionPath)
+    })
+
+    it('should support setting the public path', function () {
+      var versionPath = path.join(targetBuild, 'main-v2.0.0-beta.js')
+      var mainJs = fs.readFileSync(versionPath)
+
+      var expectedPublicPath = '__webpack_require__.p = "http://cdn.com/assets/v2.0.0-beta/9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2";'
+
+      expect(mainJs.indexOf(expectedPublicPath) !== -1).to.eql(true)
+    })
+  })
+
+  describe('public API', () => {
+    it('should expose the commithash', () => {
+      var plugin = new GitRevisionPlugin({ gitWorkTree: targetProject, lightweightTags: true })
+      expect(plugin.commithash()).to.eql('9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2')
+    })
+
+    it('should expose the version', () => {
+      var plugin = new GitRevisionPlugin({ gitWorkTree: targetProject, lightweightTags: true })
+      expect(plugin.version()).to.eql('v2.0.0-beta')
+    })
+  })
+})
+

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`0000000000000000000000000000000000000000 10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 Paulo Ragonha <paulo@ragonha.me> 1463076183 +0200 commit (initial): dummy project`
	`2`	`+10e1ff4c17ad1f12241b5c4d9a708a76e98289d8 9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2 Roman Charugin <cr@redmadrobot.com> 1469887902 +0300 push`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-10e1ff4c17ad1f12241b5c4d9a708a76e98289d8`
	`1`	`+9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+9a15b3ba1f8c347f9db94bcfde9630ed4fdeb1b2`
Original file line number	Diff line number	Diff line change
`@@ -6,19 +6,20 @@ var versionCommand = 'describe --always'`
`6`	`6`
`7`	`7`	`function GitRevisionPlugin (options) {`
`8`	`8`	`this.gitWorkTree = options && options.gitWorkTree`
	`9`	`+ this.lightweightTags = options && options.lightweightTags \|\| false`
`9`	`10`	`}`
`10`	`11`
`11`	`12`	`GitRevisionPlugin.prototype.apply = function (compiler) {`
`12`	`13`	`buildFile(compiler, this.gitWorkTree, commithashCommand, /\[git-revision-hash\]/gi, 'COMMITHASH')`
`13`		`- buildFile(compiler, this.gitWorkTree, versionCommand, /\[git-revision-version\]/gi, 'VERSION')`
	`14`	`+ buildFile(compiler, this.gitWorkTree, versionCommand + (this.lightweightTags ? ' --tags' : ''), /\[git-revision-version\]/gi, 'VERSION')`
`14`	`15`	`}`
`15`	`16`
`16`	`17`	`GitRevisionPlugin.prototype.commithash = function (callback) {`
`17`	`18`	`return runGitCommand(this.gitWorkTree, commithashCommand)`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`GitRevisionPlugin.prototype.version = function (callback) {`
`21`		`- return runGitCommand(this.gitWorkTree, versionCommand)`
	`22`	`+ return runGitCommand(this.gitWorkTree, versionCommand + (this.lightweightTags ? ' --tags' : ''))`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`module.exports = GitRevisionPlugin`