Merge pull request #36 from tartinesKiller/master

Implement LASTCOMMITDATETIME

Author: pirelenito

README.md

@@ -53,6 +53,7 @@ It is also possible to use [path substitutions](https://webpack.js.org/configura
 - `[git-revision-version]`
 - `[git-revision-hash]`
 - `[git-revision-branch]` (only [when branch is enabled](#branch-false))
+- `[git-revision-last-commit-datetime]`
 
 Example:
 
@@ -67,7 +68,7 @@ module.exports = {
 
 ## Plugin API
 
-The `VERSION`, `COMMITHASH` and `BRANCH` are also exposed through a public API.
+The `VERSION`, `COMMITHASH`, `LASTCOMMITDATETIME` and `BRANCH` are also exposed through a public API.
 
 Example using the [DefinePlugin](https://webpack.js.org/plugins/define-plugin/#usage):
 
@@ -83,6 +84,7 @@ module.exports = {
       'VERSION': JSON.stringify(gitRevisionPlugin.version()),
       'COMMITHASH': JSON.stringify(gitRevisionPlugin.commithash()),
       'BRANCH': JSON.stringify(gitRevisionPlugin.branch()),
+      'LASTCOMMITDATETIME': JSON.stringify(gitRevisionPlugin.lastcommitdatetime()),
     })
   ]
 }
@@ -172,6 +174,22 @@ module.exports = {
 }
 ```
 
+### `lastCommitDateTimeCommand: 'log -1 --format=%cI'`
+
+To change the default `git` command used to read the value of `LASTCOMMITDATETIME`:
+
+```javascript
+var GitRevisionPlugin = require('git-revision-webpack-plugin')
+
+module.exports = {
+  plugins: [
+    new GitRevisionPlugin({
+      branchCommand: 'log -1 --format=%ci'
+    })
+  ]
+}
+```
+
 ## Outdated webpack
 
 If your project is **not using webpack version 4 or greater**, you will need to install an older version of this package:

lib/index.js

@@ -4,6 +4,7 @@ var runGitCommand = require('./helpers/run-git-command')
 var COMMITHASH_COMMAND = 'rev-parse HEAD'
 var VERSION_COMMAND = 'describe --always'
 var BRANCH_COMMAND = 'rev-parse --abbrev-ref HEAD'
+var LASTCOMMITDATETIME_COMMAND = 'log -1 --format=%cI'
 
 function GitRevisionPlugin (options) {
   options = options || {}
@@ -21,6 +22,9 @@ function GitRevisionPlugin (options) {
   this.branchCommand = options.branchCommand ||
     BRANCH_COMMAND
 
+  this.lastCommitDateTimeCommand = options.lastCommitDateTimeCommand ||
+    LASTCOMMITDATETIME_COMMAND
+
   if (options.versionCommand && options.lightweightTags) {
     throw new Error('lightweightTags can\'t be used together versionCommand')
   }
@@ -43,6 +47,14 @@ GitRevisionPlugin.prototype.apply = function (compiler) {
     asset: 'VERSION'
   })
 
+  buildFile({
+    compiler: compiler,
+    gitWorkTree: this.gitWorkTree,
+    command: this.lastCommitDateTimeCommand,
+    replacePattern: /\[git-revision-last-commit-datetime\]/gi,
+    asset: 'LASTCOMMITDATETIME'
+  })
+
   if (this.createBranchFile) {
     buildFile({
       compiler: compiler,
@@ -75,4 +87,11 @@ GitRevisionPlugin.prototype.branch = function () {
   )
 }
 
+GitRevisionPlugin.prototype.lastcommitdatetime = function () {
+  return runGitCommand(
+    this.gitWorkTree,
+    this.lastCommitDateTimeCommand
+  )
+}
+
 module.exports = GitRevisionPlugin

lib/index.spec.js

@@ -102,4 +102,32 @@ describe('git-revision-webpack-plugin (unit)', function () {
       expect(runGitCommand.args[0][1]).to.eql('custom branch command')
     })
   })
+
+  describe('on setting custom last commit date time command', function () {
+    it('should run the build on .apply', function () {
+      var buildFile = sinon.spy()
+      GitRevisionPlugin.__set__('buildFile', buildFile)
+
+      new GitRevisionPlugin({
+        lastCommitDateTimeCommand: 'custom last commit date time command'
+      }).apply()
+
+      var lastCommitDateTimeCall = buildFile.args.find(function (calls) {
+        return calls[0].asset === 'LASTCOMMITDATETIME'
+      })
+
+      expect(lastCommitDateTimeCall[0].command).to.eql('custom last commit date time command')
+    })
+
+    it('should run the custom git command on .lastcommitdatetime', function () {
+      var runGitCommand = sinon.spy()
+      GitRevisionPlugin.__set__('runGitCommand', runGitCommand)
+
+      new GitRevisionPlugin({
+        lastCommitDateTimeCommand: 'custom last commit date time command'
+      }).lastcommitdatetime()
+
+      expect(runGitCommand.args[0][1]).to.eql('custom last commit date time command')
+    })
+  })
 })