Merge pull request #38 from tylerjpeterson/master

Custom HTML templates

Author: rtfpessoa

README.md

@@ -63,6 +63,7 @@ Diff to Html generates pretty HTML diffs from unified and git diff output in you
       --lm, --matching                  Diff line matching type   [choices: "lines", "words", "none"] [default: "none"]
       --lmt, --matchWordsThreshold      Diff line matching word threshold   [default: "0.25"]
       --lmm, --matchingMaxComparisons   Diff line matching maximum line comparisons of a block of changes [default: 2500]
+      --hwt, --htmlWrapperTemplate      Path to custom template to be rendered when using the "html" output format [string]
       -f, --format                      Output format   [choices: "html", "json"] [default: "html"]
       -d, --diff                        Diff style   [choices: "word", "char"] [default: "word"]
       -i, --input                       Diff input source   [choices: "file", "command", "stdin"] [default: "command"]
@@ -84,6 +85,14 @@ Diff to Html generates pretty HTML diffs from unified and git diff output in you
           -> print json format to stdout
       diff2html -F my-pretty-diff.html -- -M HEAD~1
           ->  print to file
+      diff2html -F my-pretty-diff.html --hwt my-custom-template.html -- -M HEAD~1
+          ->  print to file using custom markup
+              templates can include the following variables:
+                `<!--diff2html-css-->` - writes default CSS to page
+                `<!--diff2html-js-ui-->` - writes default JavaScript UI scripts to page
+                `//diff2html-fileListCloseable` - writes code to support selected list interaction, must be within a <script> block
+                `//diff2html-synchronisedScroll` - writes code to support selected scroll interaction, must be within a <script> block
+                `<!--diff2html-diff-->` - writes diff content to page
 
     © 2014-2016 rtfpessoa
     For support, check out https://github.com/rtfpessoa/diff2html-cli

src/cli.js

@@ -6,6 +6,7 @@
  */
 
 (function() {
+  var fs = require('fs');
   var os = require('os');
   var path = require('path');
 
@@ -66,8 +67,14 @@
   Diff2HtmlInterface.prototype.getOutput = function(baseConfig, input, callback) {
     var that = this;
     var config = baseConfig;
+    var defaultTemplate = path.resolve(__dirname, '..', 'dist', 'template.html');
     config.wordByWord = (baseConfig.diff === 'word');
     config.charByChar = (baseConfig.diff === 'char');
+    config.template = baseConfig.htmlWrapperTemplate || defaultTemplate;
+
+    if (!fs.existsSync(config.template)) {
+      return callback(new Error('Template (`' + baseConfig.template + '`) not found!'));
+    }
 
     var jsonContent = diff2Html.getJsonFromDiff(input, config);
 
@@ -99,7 +106,7 @@
   };
 
   Diff2HtmlInterface.prototype._prepareHTML = function(content, config) {
-    var templatePath = path.resolve(__dirname, '..', 'dist', 'template.html');
+    var templatePath = config.template;
     var template = utils.readFileSync(templatePath);
 
     var diff2htmlPath = path.join(path.dirname(require.resolve('diff2html')), '..');

src/main.js

@@ -129,6 +129,14 @@ var argv = yargs.usage('Usage: diff2html [options] -- [diff args]')
       type: 'string'
     }
   })
+  .options({
+    'hwt': {
+      alias: 'htmlWrapperTemplate',
+      describe: 'Use a custom template when generating markup',
+      nargs: 1,
+      type: 'string'
+    }
+  })
   .example('diff2html -s line -f html -d word -i command -o preview -- -M HEAD~1',
     'diff last commit, line by line, word comparison between lines,' +
     'previewed in the browser and input from git diff command')