bundles/js/diff2html-ui-base.min.js -
includes the wrapper of diff2html without including a highlight.js implementation. You can use it without
syntax highlight or by passing your own implementation with the languages you prefer
Diff2Html can be used in various ways as listed in the distributions section. The two main ways are:
Diff2HtmlUI: using this wrapper makes it easy to inject the html in the DOM and adds some nice
features to the diff, like syntax highlight.
Diff2Html: using the parser and html generator directly from the library gives you complete
control about what you can do with the json or html generated.
Below you can find more details and examples about each option.
Diff Text Input
diff2html accepts the text contents of a
unified diff or the superset format git
diff (https://git-scm.com/docs/git-diff) (not combined or word diff). To provide multiples files as input just
concatenate the diffs (just like the output of git diff).
Diff2HtmlUI Usage
Simple wrapper to ease simple tasks in the browser such as: code highlight and js effects
<!doctype html><html lang="en-us"> <head> <meta charset="utf-8" /> <!-- Make sure to load the highlight.js CSS file before the Diff2Html CSS file --> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.1/styles/github.min.css" /> <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/diff2html/bundles/css/diff2html.min.css" /> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/diff2html/bundles/js/diff2html-ui.min.js"></script> </head> <script> const diffString = `diff --git a/sample.js b/sample.jsindex 0000001..0ddf2ba--- a/sample.js+++ b/sample.js@@ -1 +1 @@-console.log("Hello World!")+console.log("Hello from Diff2Html!")`; document.addEventListener('DOMContentLoaded', function () { var targetElement = document.getElementById('myDiffElement'); var configuration = { drawFileList: true, fileListToggle: false, fileListStartVisible: false, fileContentToggle: false, matching: 'lines', outputFormat: 'side-by-side', synchronisedScroll: true, highlight: true, renderNothingWhenEmpty: false, }; var diff2htmlUi = new Diff2HtmlUI(targetElement, diffString, configuration); diff2htmlUi.draw(); diff2htmlUi.highlightCode(); }); </script> <body> <div id="myDiffElement"></div> </body></html>
StimulusJS with TypeScript
import { Controller } from '@hotwired/stimulus';import { Diff2HtmlUI, Diff2HtmlUIConfig } from 'diff2html/lib/ui/js/diff2html-ui-slim.js';// Requires `npm install highlight.js`import 'highlight.js/styles/github.css';import 'diff2html/bundles/css/diff2html.min.css';export default class extends Controller { connect(): void { const diff2htmlUi = new Diff2HtmlUI(this.diffElement, this.unifiedDiff, this.diffConfiguration); diff2htmlUi.draw(); } get unifiedDiff(): string { return this.data.get('unifiedDiff') || ''; } get diffElement(): HTMLElement { return this.element as HTMLElement; } get diffConfiguration(): Diff2HtmlUIConfig { return { drawFileList: true, matching: 'lines', }; }}
Diff2Html Usage
Diff2Html API
JSON representation of the diff
function parse(diffInput: string, configuration: Diff2HtmlConfig = {}): DiffFile[];
Pretty HTML representation of the diff
function html(diffInput: string | DiffFile[], configuration: Diff2HtmlConfig = {}): string;
Diff2Html Configuration
The HTML output accepts a Javascript object with configuration. Possible options:
outputFormat: the format of the output data: 'line-by-line' or 'side-by-side', default is 'line-by-line'
drawFileList: show a file list before the diff: true or false, default is true
srcPrefix: add a prefix to all source (before changes) filepaths, default is ''. Should match the prefix used when
generating the diff.
dstPrefix: add a prefix to all destination (after changes) filepaths, default is ''. Should match the prefix used
when generating the diff
diffMaxChanges: number of changed lines after which a file diff is deemed as too big and not displayed, default is
undefined
diffMaxLineLength: number of characters in a diff line after which a file diff is deemed as too big and not
displayed, default is undefined
diffTooBigMessage: function allowing to customize the message in case of file diff too big (if diffMaxChanges or
diffMaxLineLength is set). Will be given a file index as a number and should return a string.
matching: matching level: 'lines' for matching lines, 'words' for matching lines and words or 'none', default
is none
matchWordsThreshold: similarity threshold for word matching, default is 0.25
maxLineLengthHighlight: only perform diff changes highlight if lines are smaller than this, default is 10000
diffStyle: show differences level in each line: 'word' or 'char', default is 'word'
renderNothingWhenEmpty: render nothing if the diff shows no change in its comparison: true or false, default is
false
matchingMaxComparisons: perform at most this much comparisons for line matching a block of changes, default is
2500
maxLineSizeInBlockForComparison: maximum number of characters of the bigger line in a block to apply comparison,
default is 200
compiledTemplates: object (Hogan.js template values) with previously
compiled templates to replace parts of the html, default is {}. For example:
{ "tag-file-changed": Hogan.compile("<span class="d2h-tag d2h-changed d2h-changed-tag">MODIFIED</span>") }
rawTemplates: object (string values) with raw not compiled templates to replace parts of the html, default is {}.
For example: { "tag-file-changed": "<span class="d2h-tag d2h-changed d2h-changed-tag">MODIFIED</span>" }
For more information regarding the possible templates look into
src/templates
highlightLanguages: Map of extension to language name, used for highlighting. This overrides the default language
detection based on file extensions.
colorScheme: color scheme to use for the diff, default is light. Possible values are light, dark, and auto
which will use the browser's preferred color scheme.
Diff2Html Browser
Import the stylesheet and the library code.
To load correctly in the Browser you need to include the stylesheet in the final HTML.
<template> <div v-html="prettyHtml" /></template><script>import * as Diff2Html from 'diff2html';import 'diff2html/bundles/css/diff2html.min.css';export default { data() { return { diffs: '--- a/server/vendor/golang.org/x/sys/unix/zsyscall_linux_mipsle.go\n+++ b/server/vendor/golang.org/x/sys/unix/zsyscall_linux_mipsle.go\n@@ -1035,6 +1035,17 @@ func Prctl(option int, arg2 uintptr, arg3 uintptr, arg4 uintptr, arg5 uintptr) (\n \n // THIS FILE IS GENERATED BY THE COMMAND AT THE TOP; DO NOT EDIT\n \n+func Pselect(nfd int, r *FdSet, w *FdSet, e *FdSet, timeout *Timespec, sigmask *Sigset_t) (n int, err error) {\n+\tr0, _, e1 := Syscall6(SYS_PSELECT6, uintptr(nfd), uintptr(unsafe.Pointer(r)), uintptr(unsafe.Pointer(w)), uintptr(unsafe.Pointer(e)), uintptr(unsafe.Pointer(timeout)), uintptr(unsafe.Pointer(sigmask)))\n+\tn = int(r0)\n+\tif e1 != 0 {\n+\t\terr = errnoErr(e1)\n+\t}\n+\treturn\n+}\n+\n+// THIS FILE IS GENERATED BY THE COMMAND AT THE TOP; DO NOT EDIT\n+\n func read(fd int, p []byte) (n int, err error) {\n \tvar _p0 unsafe.Pointer\n \tif len(p) > 0 {\n', }; }, computed: { prettyHtml() { return Diff2Html.html(this.diffs, { drawFileList: true, matching: 'lines', outputFormat: 'side-by-side', }); }, },};</script>
Troubleshooting
1. Out of memory or Slow execution
Causes:
Big files
Big lines
Fix:
Disable the line matching algorithm, by setting the option {"matching": "none"} when invoking diff2html
Contribute
This is a developer friendly project, all the contributions are welcome. To contribute just send a pull request with
your changes following the guidelines described in CONTRIBUTING.md. I will try to review them as soon as possible.
Contributors
Thanks goes to these wonderful people (emoji key):
lib/ui/js/diff2html-ui.js - includes the
wrapper of diff2html with highlight for all highlight.js supported languages
lib/ui/js/diff2html-ui-slim.js -
includes the wrapper of diff2html with "the most common" highlight.js supported languages
lib/ui/js/diff2html-ui-base.js -
includes the wrapper of diff2html without including a highlight.js implementation. You can use it without
syntax highlight or by passing your own implementation with the languages you prefer