diff2html-cli

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

Table of Contents

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

Features

• 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

Online Example

Go to Diff2HTML

Distributions

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

Setup

npm install -g diff2html-cli

Usage

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

| flag | alias | description | choices | default | | ----- | ------------------------ | -------------------------------------------------------------------------- | ---------------------------- | --------- | | -s | --style | Output style |

line

side

line

true

false

true

true

false

true

closed

open

hidden

closed

word

char

word

lines

words

none

none

0.25

2500

html

[string]

html

json

html

file

command

stdin

command

preview

stdout

preview

browser

pbcopy

print

[string]

[string]

Exit Status Codes

• :tada: 0: Success
• :dizzy_face: 1: Generic Error
• :cold_sweat: 3: Input diff is empty
• :cop: 4: Value of

  --hwt | --htmlWrapperTemplate

  is not a valid file

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:

• Inside the
  tag

• Inside the
  tag

Examples

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

--

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

Developing

Make some changes,

yarn build

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