diff2html (original) (raw)

3.4.51 β€’ Public β€’ Published 4 months ago

diff2html

npm node npm GitHub Actions

npm weekly downloads npm monthly downloads npm yearly downloads npm downloads

jsdelivr CDN Downloads All Contributors

diff2html generates pretty HTML diffs from git diff or unified diff output.

Table of Contents

Features

Online Example

Go to diff2html

Distributions

Usage

Diff2Html can be used in various ways as listed in the distributions section. The two main ways are:

Below you can find more details and examples about each option.

Diff Text Input

diff2html accepts the text contents of aunified 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

Diff2HtmlUI API

Create a Diff2HtmlUI instance

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

Enable extra features

synchronisedScroll(): void fileListToggle(startVisible: boolean): void highlightCode(): void stickyFileHeaders(): void

Diff2HtmlUI Configuration

Diff2HtmlUI Browser

Mandatory HTML resource imports

Init

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

Syntax Highlight

NOTE: The highlight.js css should come before the diff2html css

Pass the option highlight with value true or invoke diff2htmlUi.highlightCode() after diff2htmlUi.draw().

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.

Collapsable File Summary List

Add the dependencies.

Invoke the Diff2HtmlUI helper Pass the option fileListToggle with value true or invokediff2htmlUi.fileListToggle() after diff2htmlUi.draw().

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

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:

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.

It will now be available as a global variable named Diff2Html.

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

const Diff2html = require('diff2html'); const diffJson = Diff2html.parse(''); const diffHtml = Diff2html.html(diffJson, { drawFileList: true }); console.log(diffHtml);

Diff2Html Examples

Example with Angular

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 = '--- 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'; let outputHtml = Diff2Html.html(strInput, { drawFileList: true, matching: 'lines' }); this.outputHtml = outputHtml; } }

diff2html

"styles": [ "diff2html.min.css" ]

Example with Vue.js

Troubleshooting

1. Out of memory or Slow execution

Causes:

Fix:

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):

Rodrigo FernandesπŸ’» stockmindπŸ’» Ivan VorontsovπŸ’» Nick BrewerπŸ’» Matt WadeπŸ› πŸ’» Rafael CortΓͺsπŸ’» Nuno TeixeiraπŸ’»
Koki OyatsuπŸ› πŸ’» James MongerπŸ“– Wessel van der PalπŸ›‘οΈ πŸ’» jk-kimπŸ’» Sergey SemenovπŸ› πŸ’» Nick MitchellπŸ› πŸ’» Samir AguiarπŸ“–
pubkeyπŸ“– πŸ’» Π˜Π»ΡŒΡπŸ“– Mohamed AkramπŸ› πŸ“– πŸ’» Eugene MarcotteπŸ’» Dima Sabanin🚧 πŸ’» Ben AbbottπŸ“– εΌ˜ζ ‘@ι˜Ώι‡ŒπŸ› πŸ“–
Mikko RantanenπŸ› AnnπŸ“– escitalopramπŸ’» dependabot[bot]πŸ›‘οΈ 🚧 Josh GoldbergπŸ’» AaronπŸ“– Pierre GrimaudπŸ“–
Adam JonesπŸ“– Arthur CharguΓ©raudπŸ“– Pierric CistacπŸ“– πŸ’» Civan YavuzşenπŸ’» Tim GatesπŸ“– campersauπŸ’» dependabot-preview[bot]πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Copyright 2014-present Rodrigo Fernandes. Released under the terms of the MIT license.

Thanks

This project is inspired in pretty-diff byScott GonzΓ‘lez.