Home

Awesome

diff2html-cli

npm node npm GitHub Actions

npm weekly downloads npm monthly downloads npm yearly downloads npm downloads

Diff to Html generates pretty HTML diffs from unified and git diff output in your terminal

Table of Contents

<!-- toc --> <!-- tocstop -->

Features

Online Example

Go to Diff2HTML

Distributions

Setup

npm install -g diff2html-cli

Usage

Usage: diff2html [ flags and/or options ] -- [git diff passthrough flags and options]

flagaliasdescriptionchoicesdefault
-s--styleOutput styleline, sideline
--fct--fileContentToggleAdds a viewed checkbox to toggle file contenttrue, falsetrue
--sc--synchronisedScrollSynchronised horizontal scrolltrue, falsetrue
--hc--highlightCodeHighlight codetrue, falsetrue
--cs--colorSchemeColor schemeauto, dark, lightauto
--su--summaryShow files summaryclosed, open, hiddenclosed
-d--diffStyleDiff styleword, charword
--lm--matchingDiff line matching typelines, words, nonenone
--lmt--matchWordsThresholdDiff line matching word threshold0.25
--lmm--matchingMaxComparisonsDiff line matching maximum line comparisons of a block of changes2500
--diffMaxChangesNumber of changed lines after which a file diff is deemed as too big and not displayed
--diffMaxLineLengthNumber of characters in a diff line after which a file diff is deemed as too big and not displayed
--renderNothingWhenEmptyRender nothing if the diff shows no change in its comparisonfalse
--maxLineSizeInBlockForComparisonMaximum number of characters of the bigger line in a block to apply comparison200
--maxLineLengthHighlightMaximum number of characters in a line to apply highlight10000
--hwt--htmlWrapperTemplatePath to custom template to be rendered when using the html output format[string]
-t--titlePage title for html output[string]
-f--formatOutput formathtml, jsonhtml
-i--inputDiff input sourcefile, command, stdincommand
-o--outputOutput destinationpreview, stdoutpreview
-u--diffyUpload to diffy.orgbrowser, pbcopy, print
-F--fileSend output to file (overrides output option)[string]
--ig--ignoreIgnore particular files from the diff[string]
-v--versionShow version number
-h--helpShow help

Exit Status Codes

Custom HTML wrapper template

The template is a very based on a simple replace of several placeholders as coded https://github.com/rtfpessoa/diff2html-cli/blob/master/src/cli.ts#L40

To provide a custom template you need to make sure you have the following comments and imports in your HTML, exactly as they are here:

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/github.min.css" />
<!--diff2html-css-->
<!--diff2html-js-ui-->
<script>
  document.addEventListener('DOMContentLoaded', () => {
    const targetElement = document.getElementById('diff');
    const diff2htmlUi = new Diff2HtmlUI(targetElement);
    //diff2html-fileListToggle
    //diff2html-synchronisedScroll
    //diff2html-highlightCode
  });
</script>
<div id="diff">
  <!--diff2html-diff-->
</div>

Examples

diff2html -s line -f html -d word -i command -o preview -- -M HEAD~1

diff2html -i file -- my-file-diff.diff

diff -u file1.txt file2.txt | diff2html -i stdin

diff2html -f json -o stdout -- -M HEAD~1

diff2html -F my-pretty-diff.html -- -M HEAD~1

diff2html -F my-pretty-diff.html --hwt my-custom-template.html -- -M HEAD~1

diff2html --ig package-lock.json --ig yarn.lock

NOTE: notice the -- in the examples

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.

Developing

Make some changes, yarn build and then ./bin/diff2html 😉

License

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

Thanks

This project is inspired in pretty-diff by Scott González.