Convert source to TypeScript 🔐

There is a missing type definition for the assetPath hook.

Author: pirelenito

package.json

@@ -37,13 +37,14 @@
     }
   },
   "prettier": {
-    "printWidth": 80,
-    "semi": true,
+    "printWidth": 120,
+    "semi": false,
     "singleQuote": true,
-    "trailingComma": "es5"
+    "trailingComma": "all"
   },
   "devDependencies": {
     "@types/jest": "^24.0.18",
+    "@types/webpack": "^4.39.2",
     "husky": "^3.0.8",
     "tsdx": "^0.9.3",
     "tslib": "^1.10.0",

src/build-file.js

@@ -0,0 +1,50 @@
+import runGitCommand from './helpers/run-git-command'
+import { Compiler } from 'webpack'
+
+interface BuildFileOptions {
+  compiler: Compiler
+  gitWorkTree?: string
+  command: string
+  replacePattern: RegExp
+  asset: string
+}
+
+export default function buildFile({ compiler, gitWorkTree, command, replacePattern, asset }: BuildFileOptions) {
+  let data: string | undefined = ''
+
+  compiler.hooks.compilation.tap('GitRevisionWebpackPlugin', compilation => {
+    compilation.hooks.optimizeTree.tapAsync('optimize-tree', (_, __, callback) => {
+      runGitCommand(gitWorkTree, command, function(err, res) {
+        if (err) {
+          return callback(err)
+        }
+        data = res
+
+        callback()
+      })
+    })
+
+    // we are missing the type definition for assetPath
+    // TODO: create a PR to DefinitelyTyped
+    const mainTemplate = compilation.mainTemplate as any
+
+    // TODO remove `any` once we get the type definitions
+    mainTemplate.hooks.assetPath.tap('GitRevisionWebpackPlugin', (assetPath: any, chunkData: any) => {
+      const path = typeof assetPath === 'function' ? assetPath(chunkData) : assetPath
+
+      if (!data) return path
+      return path.replace(replacePattern, data)
+    })
+  })
+
+  compiler.hooks.emit.tap('GitRevisionWebpackPlugin', compilation => {
+    compilation.assets[asset] = {
+      source: function() {
+        return data
+      },
+      size: function() {
+        return data ? data.length : 0
+      },
+    }
+  })
+}

src/build-file.ts

@@ -0,0 +1,3 @@
+export default function removeEmptyLines(string: string) {
+  return string.replace(/[\s\r\n]+$/, '')
+}

src/helpers/remove-empty-lines.js

@@ -0,0 +1,27 @@
+import { exec } from 'child_process'
+import { execSync } from 'child_process'
+import path from 'path'
+import removeEmptyLines from './remove-empty-lines'
+
+interface Cb {
+  (err: Error | null, output?: string): void
+}
+
+export default function(gitWorkTree: string | undefined, command: string, callback?: Cb) {
+  const gitCommand = gitWorkTree
+    ? ['git', '--git-dir=' + path.join(gitWorkTree, '.git'), '--work-tree=' + gitWorkTree, command].join(' ')
+    : ['git', command].join(' ')
+
+  if (callback) {
+    exec(gitCommand, function(err, stdout) {
+      if (err) {
+        return callback(err)
+      }
+      callback(null, removeEmptyLines(stdout))
+    })
+
+    return null
+  } else {
+    return removeEmptyLines(`${execSync(gitCommand)}`)
+  }
+}

src/helpers/remove-empty-lines.ts

@@ -0,0 +1,92 @@
+import buildFile from './build-file'
+import runGitCommand from './helpers/run-git-command'
+import { Compiler } from 'webpack'
+
+const COMMITHASH_COMMAND = 'rev-parse HEAD'
+const VERSION_COMMAND = 'describe --always'
+const BRANCH_COMMAND = 'rev-parse --abbrev-ref HEAD'
+const LASTCOMMITDATETIME_COMMAND = 'log -1 --format=%cI'
+
+interface GitRevisionPluginOptions {
+  gitWorkTree?: string
+  commithashCommand?: string
+  versionCommand?: string
+  branch?: boolean
+  branchCommand?: string
+  lastCommitDateTimeCommand?: string
+  lightweightTags?: boolean
+}
+
+export default class GitRevisionPlugin {
+  gitWorkTree?: string
+  commithashCommand: string
+  versionCommand: string
+  createBranchFile: boolean
+  branchCommand: string
+  lastCommitDateTimeCommand: string
+
+  constructor(options: GitRevisionPluginOptions = {}) {
+    this.gitWorkTree = options.gitWorkTree
+    this.commithashCommand = options.commithashCommand || COMMITHASH_COMMAND
+    this.versionCommand = options.versionCommand || VERSION_COMMAND + (options.lightweightTags ? ' --tags' : '')
+    this.createBranchFile = options.branch || false
+    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")
+    }
+  }
+
+  commithash() {
+    return runGitCommand(this.gitWorkTree, this.commithashCommand)
+  }
+
+  version() {
+    return runGitCommand(this.gitWorkTree, this.versionCommand)
+  }
+
+  branch() {
+    return runGitCommand(this.gitWorkTree, this.branchCommand)
+  }
+
+  lastcommitdatetime() {
+    return runGitCommand(this.gitWorkTree, this.lastCommitDateTimeCommand)
+  }
+
+  apply(compiler: Compiler) {
+    buildFile({
+      compiler: compiler,
+      gitWorkTree: this.gitWorkTree,
+      command: this.commithashCommand,
+      replacePattern: /\[git-revision-hash\]/gi,
+      asset: 'COMMITHASH',
+    })
+
+    buildFile({
+      compiler: compiler,
+      gitWorkTree: this.gitWorkTree,
+      command: this.versionCommand,
+      replacePattern: /\[git-revision-version\]/gi,
+      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,
+        gitWorkTree: this.gitWorkTree,
+        command: this.branchCommand,
+        replacePattern: /\[git-revision-branch\]/gi,
+        asset: 'BRANCH',
+      })
+    }
+  }
+}

src/helpers/run-git-command.js

@@ -3,7 +3,7 @@
   "compilerOptions": {
     "target": "es5",
     "module": "esnext",
-    "lib": ["dom", "esnext"],
+    "lib": ["esnext"],
     "importHelpers": true,
     "declaration": true,
     "sourceMap": true,