gem-hunter

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

• Features
• Online Example
• Distributions
• Setup
• Usage
  • Exit Status Codes
  • Custom HTML wrapper template
  • Examples
• Contribute
• Developing
• License
• Thanks

• Unified diff and Git diff input

• line-by-line and side-by-side diff

• new and old line numbers

• inserted and removed lines

• GitHub like style

• Code syntax highlight

• Line similarity matching

Go to Diff2HTML

• NPM CLI
• NPM / Node.js library [ES5 & ES6]
• CDNJS
• WebJar

npm install -g diff2html-cli

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

• 🎉 0: Success
• 😵 1: Generic Error
• 😰 3: Input diff is empty
• 👮 4: Value of --hwt | --htmlWrapperTemplate is not a valid file

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:

• Inside the <head> tag

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

• Inside the <body> tag

<div id="diff">
  <!--diff2html-diff-->
</div>

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

• diff last commit, line by line, word comparison between lines, previewed in the browser and input from git diff command

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

• reading the input from a file

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

• reading diff from stdin

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

• print json format to stdout

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

• print to file

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

• print to file using custom markup templates can include the following variables

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

• Ignore package-lock.json and yarn.lock from the generated diff

NOTE: notice the -- in the examples

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.

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

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

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