# diff2html [![npm](https://img.shields.io/npm/v/diff2html)](https://www.npmjs.com/package/diff2html) [![node](https://img.shields.io/node/v/diff2html)](https://www.npmjs.com/package/diff2html) [![npm](https://img.shields.io/npm/l/diff2html)](https://www.npmjs.com/package/diff2html) [![GitHub Actions](https://github.com/rtfpessoa/diff2html/actions/workflows/release.yml/badge.svg)](https://github.com/rtfpessoa/diff2html/actions/workflows/release.yml) [![npm weekly downloads](https://img.shields.io/npm/dw/diff2html)](https://www.npmjs.com/package/diff2html) [![npm monthly downloads](https://img.shields.io/npm/dm/diff2html)](https://www.npmjs.com/package/diff2html) [![npm yearly downloads](https://img.shields.io/npm/dy/diff2html)](https://www.npmjs.com/package/diff2html) [![npm downloads](https://img.shields.io/npm/dt/diff2html)](https://www.npmjs.com/package/diff2html) [![jsdelivr CDN Downloads](https://data.jsdelivr.com/v1/package/npm/diff2html/badge)](https://www.jsdelivr.com/package/npm/diff2html) [![All Contributors](https://img.shields.io/badge/all_contributors-22-orange)](#contributors) diff2html generates pretty HTML diffs from git diff or unified diff output. ## Table of Contents - [Features](#features) - [Online Example](#online-example) - [Distributions](#distributions) - [Usage](#usage) - [Diff Text Input](#diff-text-input) - [Diff2HtmlUI Usage](#diff2htmlui-usage) - [Diff2HtmlUI API](#diff2htmlui-api) - [Diff2HtmlUI Configuration](#diff2htmlui-configuration) - [Diff2HtmlUI Browser](#diff2htmlui-browser) - [Diff2HtmlUI Examples](#diff2htmlui-examples) - [Diff2Html Usage](#diff2html-usage) - [Diff2Html API](#diff2html-api) - [Diff2Html Configuration](#diff2html-configuration) - [Diff2Html Browser](#diff2html-browser) - [Diff2Html NPM / Node.js Library](#diff2html-npm--nodejs-library) - [Diff2Html Examples](#diff2html-examples) - [Troubleshooting](#troubleshooting) - [1. Out of memory or Slow execution](#1-out-of-memory-or-slow-execution) - [Contribute](#contribute) - [Contributors](#contributors) - [License](#license) - [Thanks](#thanks) ## Features - Supports git and unified diffs - Line by line and Side by side diff - New and old line numbers - Inserted and removed lines - GitHub like visual style - Code syntax highlight - Line similarity matching - Easy code selection ## Online Example > Go to [diff2html](https://diff2html.xyz/demo.html) ## Distributions - [jsdelivr CDN](https://www.jsdelivr.com/package/npm/diff2html) - [WebJar](http://www.webjars.org/) - [Node Library](https://www.npmjs.org/package/diff2html) - [NPM CLI](https://www.npmjs.org/package/diff2html-cli) - Manually use from jsdelivr or build the project: - Browser / Bundle - Parser and HTML Generator - [bundles/js/diff2html.min.js](https://cdn.jsdelivr.net/npm/diff2html/bundles/js/diff2html.min.js) - includes the diff parser and html generator - Wrapper and helper adding syntax highlight, synchronized scroll, and other nice features - [bundles/js/diff2html-ui.min.js](https://cdn.jsdelivr.net/npm/diff2html/bundles/js/diff2html-ui.min.js) - includes the wrapper of diff2html with highlight for all `highlight.js` supported languages - [bundles/js/diff2html-ui-slim.min.js](https://cdn.jsdelivr.net/npm/diff2html/bundles/js/diff2html-ui-slim.min.js) - includes the wrapper of diff2html with "the most common" `highlight.js` supported languages - [bundles/js/diff2html-ui-base.min.js](https://cdn.jsdelivr.net/npm/diff2html/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 - NPM / Node.js library - ES5 - [lib/diff2html.js](https://cdn.jsdelivr.net/npm/diff2html/lib/diff2html.js) - includes the diff parser and html generator - [lib/ui/js/diff2html-ui.js](https://cdn.jsdelivr.net/npm/diff2html/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](https://cdn.jsdelivr.net/npm/diff2html/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](https://cdn.jsdelivr.net/npm/diff2html/lib/ui/js/diff2html-ui-base.js) - ES6 - [lib-esm/diff2html.js](https://cdn.jsdelivr.net/npm/diff2html/lib-esm/diff2html.js) - includes the diff parser and html generator - [lib/ui/js/diff2html-ui.js](https://cdn.jsdelivr.net/npm/diff2html/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](https://cdn.jsdelivr.net/npm/diff2html/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](https://cdn.jsdelivr.net/npm/diff2html/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 ## Usage Diff2Html can be used in various ways as listed in the [distributions](#distributions) section. The two main ways are: - [Diff2HtmlUI](#diff2htmlui-usage): 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](#diff2html-usage): 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](https://www.gnu.org/software/diffutils/manual/html_node/Unified-Format.html) 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 - Invoke Diff2html - Inject output in DOM element - Enable collapsible file summary list - Enable syntax highlight of the code in the diffs ### Diff2HtmlUI API > Create a Diff2HtmlUI instance ```ts constructor(target: HTMLElement, diffInput?: string | DiffFile[]) // diff2html-ui, diff2html-ui-slim constructor(target: HTMLElement, diffInput?: string | DiffFile[], config: Diff2HtmlUIConfig = {}, hljs?: HighlightJS) // diff2html-ui-base ``` > Generate and inject in the document the Pretty HTML representation of the diff ```ts draw(): void ``` > Enable extra features ```ts synchronisedScroll(): void fileListToggle(startVisible: boolean): void highlightCode(): void stickyFileHeaders(): void ``` ### Diff2HtmlUI Configuration - `synchronisedScroll`: scroll both panes in side-by-side mode: `true` or `false`, default is `true` - `highlight`: syntax highlight the code on the diff: `true` or `false`, default is `true` - `fileListToggle`: allow the file summary list to be toggled: `true` or `false`, default is `true` - `fileListStartVisible`: choose if the file summary list starts visible: `true` or `false`, default is `false` - `fileContentToggle`: allow each file contents to be toggled: `true` or `false`, default is `true` - `stickyFileHeaders`: make file headers sticky: `true` or `false`, default is `true` - [All the options](#diff2html-configuration) from Diff2Html are also valid configurations in Diff2HtmlUI ### Diff2HtmlUI Browser #### Mandatory HTML resource imports ```html ``` #### Init ```js const targetElement = document.getElementById('destination-elem-id'); const configuration = { drawFileList: true, matching: 'lines' }; const diff2htmlUi = new Diff2HtmlUI(targetElement, diffString, configuration); // or const diff2htmlUi = new Diff2HtmlUI(targetElement, diffJson, configuration); ``` #### Draw ```js diff2htmlUi.draw(); ``` #### Syntax Highlight **NOTE:** The highlight.js css should come before the diff2html css ```html ``` > Pass the option `highlight` with value true or invoke `diff2htmlUi.highlightCode()` after `diff2htmlUi.draw()`. ```js document.addEventListener('DOMContentLoaded', () => { const diffString = `diff --git a/sample.js b/sample.js index 0000001..0ddf2ba --- a/sample.js +++ b/sample.js @@ -1 +1 @@ -console.log("Hello World!") +console.log("Hello from Diff2Html!")`; const targetElement = document.getElementById('myDiffElement'); const configuration = { drawFileList: true, matching: 'lines', highlight: true }; const diff2htmlUi = new Diff2HtmlUI(targetElement, diffString, configuration); diff2htmlUi.draw(); diff2htmlUi.highlightCode(); }); ``` When using the `auto` color scheme, you will need to specify both the light and dark themes for highlight.js to use. ```html ``` #### Collapsable File Summary List > Add the dependencies. ```html ``` > Invoke the Diff2HtmlUI helper Pass the option `fileListToggle` with value true or invoke > `diff2htmlUi.fileListToggle()` after `diff2htmlUi.draw()`. ```js document.addEventListener('DOMContentLoaded', () => { const targetElement = document.getElementById('myDiffElement'); var diff2htmlUi = new Diff2HtmlUI(targetElement, lineDiffExample, { drawFileList: true, matching: 'lines' }); diff2htmlUi.draw(); diff2htmlUi.fileListToggle(false); }); ``` ### Diff2HtmlUI Examples #### Example with plain HTML+CSS+JS ```html

``` #### StimulusJS with TypeScript ```ts 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 ```ts function parse(diffInput: string, configuration: Diff2HtmlConfig = {}): DiffFile[]; ``` > Pretty HTML representation of the diff ```ts 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](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---src-prefixltprefixgt). - `dstPrefix`: add a prefix to all destination (after changes) filepaths, default is `''`. Should match the prefix used when [generating the diff](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---dst-prefixltprefixgt) - `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](https://github.com/twitter/hogan.js/) template values) with previously compiled templates to replace parts of the html, default is `{}`. For example: `{ "tag-file-changed": Hogan.compile("MODIFIED") }` - `rawTemplates`: object (string values) with raw not compiled templates to replace parts of the html, default is `{}`. For example: `{ "tag-file-changed": "MODIFIED" }` > For more information regarding the possible templates look into > [src/templates](https://github.com/rtfpessoa/diff2html/tree/master/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. ```html ``` It will now be available as a global variable named `Diff2Html`. ```js document.addEventListener('DOMContentLoaded', () => { var diffHtml = Diff2Html.html('', { drawFileList: true, matching: 'lines', outputFormat: 'side-by-side', }); document.getElementById('destination-elem-id').innerHTML = diffHtml; }); ``` ### Diff2Html NPM / Node.js Library ```js const Diff2html = require('diff2html'); const diffJson = Diff2html.parse(''); const diffHtml = Diff2html.html(diffJson, { drawFileList: true }); console.log(diffHtml); ``` ### Diff2Html Examples #### Example with Angular - Typescript ```typescript import * as Diff2Html from 'diff2html'; import { Component, OnInit } from '@angular/core'; export class AppDiffComponent implements OnInit { outputHtml: string; constructor() { this.init(); } ngOnInit() {} init() { let strInput = '--

What it does

Available capabilities

Tags

Ways to use it