Merge pull request #15 from rtfpessoa/cleaning

Clean project, better module exposing and documentation
rtfpessoa · Jul 19, 2015 · df6d5bb · df6d5bb
2 parents ffeaec2 + aac689e
commit df6d5bb
Show file tree

Hide file tree

Showing 14 changed files with 238 additions and 128 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Diff to Html by [rtfpessoa](https://github.com/rtfpessoa)
 
-Diff to Html generates pretty HTML diffs from git word diff output.
+Diff to Html generates pretty HTML diffs from git diff output.
 
 ## Features
 
@@ -12,6 +12,8 @@ Diff to Html generates pretty HTML diffs from git word diff output.
 
 * GitHub like style
 
+* Code syntax highlight
+
 ## Online Example
 
 > Go to [Diff2HTML](http://rtfpessoa.github.io/diff2html/)
@@ -24,6 +26,8 @@ Diff to Html generates pretty HTML diffs from git word diff output.
 
 * [Bower Package](http://bower.io/search/?q=diff2html)
 
+* [Node CLI](https://www.npmjs.org/package/diff2html-cli)
+
 * Manually download and import `dist/diff2html.min.js` into your page
 
 ## How to use
@@ -50,11 +54,60 @@ Diff to Html generates pretty HTML diffs from git word diff output.
 
 > Check out the `index.html` for a complete example.
 
+## Sintax Hightlight
+
+> Add the dependencies.
+Choose one color scheme, and add the main highlight code.
+If your favourite language is not included in the default package also add its javascript highlight file.
+jQuery is optional, just using it to help managing the highlight.
+
+```html
+<!-- Stylesheet -->
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/github.min.css">
+
+<!-- Javascripts -->
+<script src="https://code.jquery.com/jquery-2.1.3.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/highlight.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/languages/scala.min.js"></script>
+```
+
+> Invoke the highlightjs plugin
+
+```js
+document.addEventListener("DOMContentLoaded", function () {
+    // parse the diff to json
+    var diffJson = Diff2Html.getJsonFromDiff(lineDiffExample);
+
+    // collect all the file extensions in the json
+    var allFileLanguages = diffJson.map(function (line) {
+        return line.language;
+    });
+
+    // remove duplicated languages
+    var distinctLanguages = allFileLanguages.filter(function (v, i) {
+        return allFileLanguages.indexOf(v) == i;
+    });
+
+    // pass the languages to the highlightjs plugin
+    hljs.configure({languages: distinctLanguages});
+
+    // generate and inject the diff HTML into the desired place
+    document.getElementById("line-by-line").innerHTML = Diff2Html.getPrettyHtmlFromJson(diffJson);
+    document.getElementById("side-by-side").innerHTML = Diff2Html.getPrettySideBySideHtmlFromJson(diffJson);
+
+    // collect all the code lines and execute the highlight on them
+    var codeLines = document.getElementsByClassName("d2h-code-line-ctn");
+    [].forEach.call(codeLines, function (line) {
+        hljs.highlightBlock(line);
+    });
+});
+```
+
 ## Contributions
 
 All the contributions are welcome.
 
-To contribute just send a pull request with your feature,fix,... and it will be reviewed asap.
+To contribute just send a pull request with your changes and I will review it asap.
 
 ## License
 

diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "diff2html",
   "version": "0.2.5-1",
-  "homepage": "https://github.com/rtfpessoa/diff2html",
+  "homepage": "http://rtfpessoa.github.io/diff2html/",
   "description": "Fast Diff to colorized HTML",
   "keywords": [
     "git",

diff --git a/dist/diff2html.js b/dist/diff2html.js
@@ -1,8 +1,25 @@
 // Diff2Html minifier version (automatically generated)
-var global = this;
+/*
+ * Hack to allow nodejs require("package/file") in the browser
+ *  How?
+ *    Since every require is used as an object:
+ *      `require("./utils.js").Utils` // (notice the `.Utils`)
+ *
+ *    We can say that when there is no require method
+ *    we use the global object in which the `Utils`
+ *    object was already injected.
+ */
+
+var $globalHolder = (typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof this !== 'undefined' && this) ||
+  Function('return this')();
 function require() {
-  return global;
-}/* See LICENSE file for terms of use */
+  return $globalHolder;
+}
+/* See LICENSE file for terms of use */
 
 /*
  * Text diff implementation.
@@ -652,7 +669,7 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   function Utils() {
   }
@@ -673,11 +690,13 @@ function require() {
     return value ? value : "";
   };
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.Utils = new Utils();
-  } else if (typeof global.Utils === 'undefined') {
-    global.Utils = new Utils();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["Utils"] = new Utils();
 
 })(this);
 /*
@@ -687,7 +706,7 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   var utils = require("./utils.js").Utils;
 
@@ -895,11 +914,13 @@ function require() {
     else return language;
   }
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.DiffParser = new DiffParser();
-  } else if (typeof global.DiffParser === 'undefined') {
-    global.DiffParser = new DiffParser();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["DiffParser"] = new DiffParser();
 
 })(this);
 /*
@@ -909,12 +930,10 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   // dirty hack for browser compatibility
-  var jsDiff = (typeof JsDiff !== "undefined" && JsDiff) ||
-    require("diff") ||
-    require("../lib/diff.js");
+  var jsDiff = (typeof JsDiff !== "undefined" && JsDiff) || require("diff");
   var utils = require("./utils.js").Utils;
 
   function PrinterUtils() {
@@ -988,11 +1007,13 @@ function require() {
     return line.replace(/(<del>((.|\n)*?)<\/del>)/g, "");
   }
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.PrinterUtils = new PrinterUtils();
-  } else if (typeof global.PrinterUtils === 'undefined') {
-    global.PrinterUtils = new PrinterUtils();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["PrinterUtils"] = new PrinterUtils();
 
 })(this);
 /*
@@ -1002,7 +1023,7 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   var diffParser = require("./diff-parser.js").DiffParser;
   var printerUtils = require("./printer-utils.js").PrinterUtils;
@@ -1183,11 +1204,13 @@ function require() {
     return fileHtml;
   }
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.SideBySidePrinter = new SideBySidePrinter();
-  } else if (typeof global.SideBySidePrinter === 'undefined') {
-    global.SideBySidePrinter = new SideBySidePrinter();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["SideBySidePrinter"] = new SideBySidePrinter();
 
 })(this);
 /*
@@ -1197,7 +1220,7 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   var diffParser = require("./diff-parser.js").DiffParser;
   var printerUtils = require("./printer-utils.js").PrinterUtils;
@@ -1342,11 +1365,13 @@ function require() {
       "</tr>\n";
   }
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.LineByLinePrinter = new LineByLinePrinter();
-  } else if (typeof global.LineByLinePrinter === 'undefined') {
-    global.LineByLinePrinter = new LineByLinePrinter();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["LineByLinePrinter"] = new LineByLinePrinter();
 
 })(this);
 /*
@@ -1356,7 +1381,7 @@ function require() {
  *
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   var lineByLinePrinter = require("./line-by-line-printer.js").LineByLinePrinter;
   var sideBySidePrinter = require("./side-by-side-printer.js").SideBySidePrinter;
@@ -1368,23 +1393,23 @@ function require() {
 
   HtmlPrinter.prototype.generateSideBySideJsonHtml = sideBySidePrinter.generateSideBySideJsonHtml;
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.HtmlPrinter = new HtmlPrinter();
-  } else if (typeof global.HtmlPrinter === 'undefined') {
-    global.HtmlPrinter = new HtmlPrinter();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["HtmlPrinter"] = new HtmlPrinter();
 
 })(this);
 /*
  *
  * Diff to HTML (diff2html.js)
  * Author: rtfpessoa
  *
- * Diff commands:
- *   git diff
  */
 
-(function (global, undefined) {
+(function (ctx, undefined) {
 
   var diffParser = require("./diff-parser.js").DiffParser;
   var htmlPrinter = require("./html-printer.js").HtmlPrinter;
@@ -1393,13 +1418,12 @@ function require() {
   }
 
   /*
-   * config
-   * {
-   * "wordByWord" : true (default)
-   * OR
-   * "charByChar" : true
-   * }
-   *
+   * Line diff type configuration
+   var config = {
+   "wordByWord": true, // (default)
+   // OR
+   "charByChar": true
+   };
    */
 
   /*
@@ -1444,10 +1468,12 @@ function require() {
     return htmlPrinter.generateSideBySideJsonHtml(diffJson, configOrEmpty);
   };
 
-  if (typeof module !== 'undefined' && module.exports) {
-    module.exports.Diff2Html = new Diff2Html();
-  } else if (typeof global.Diff2Html === 'undefined') {
-    global.Diff2Html = new Diff2Html();
-  }
+  // expose this module
+  ((typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof $this !== 'undefined' && $this) ||
+  Function('return this')())["Diff2Html"] = new Diff2Html();
 
 })(this);
diff --git a/dist/diff2html.min.js b/dist/diff2html.min.js
diff --git a/lib/fakeRequire.js b/lib/fakeRequire.js
@@ -1,4 +1,20 @@
-var global = this;
+/*
+ * Hack to allow nodejs require("package/file") in the browser
+ *  How?
+ *    Since every require is used as an object:
+ *      `require("./utils.js").Utils` // (notice the `.Utils`)
+ *
+ *    We can say that when there is no require method
+ *    we use the global object in which the `Utils`
+ *    object was already injected.
+ */
+
+var $globalHolder = (typeof module !== 'undefined' && module.exports) ||
+  (typeof exports !== 'undefined' && exports) ||
+  (typeof window !== 'undefined' && window) ||
+  (typeof self !== 'undefined' && self) ||
+  (typeof this !== 'undefined' && this) ||
+  Function('return this')();
 function require() {
-  return global;
-}
+  return $globalHolder;
+}
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name":     "diff2html",
-  "version":  "0.2.5-1",
-  "homepage": "https://www.github.com/rtfpessoa/diff2html",
+  "version":  "0.2.6",
+  "homepage": "http://rtfpessoa.github.io/diff2html/",
   "description": "Fast Diff to colorized HTML",
   "keywords": [
       "git",