Need help with diff2html-cli?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Global Rank
#55,363
Topics of expertise
http4s
akka-ht...
scala-n...
dropwiz...
sbt-plu...
packagi...
scalajs
rubygem...
Location
Lisbon
302 Stars 30 Forks MIT License 304 Commits 5 Opened issues

Description

Pretty diff to html javascript cli (diff2html-cli)

Services available

!
?

Need anything else?

Contributors list

# 55,363
Maven
scalajs
http4s
Racket
127 commits
# 42,349
angular...
angular...
sqlite3
SQL
39 commits
# 398,004
HTML
Git
unified
CSS
7 commits
# 40,050
Less
messeng...
Express
ionic
3 commits
# 872
GitHub
rust-la...
wechat-...
query-l...
2 commits
# 11,006
Node.js
JavaScr...
Less
Git
1 commit
# 42,390
CSS
gtfs
transit
Django
1 commit
# 267,685
React
emotico...
CSS
emoji-p...
1 commit

diff2html-cli

Codacy Quality Badge Codacy Coverage Badge Circle CI

npm David David

node npm npm Gitter

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

Table of Contents

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

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
| | --sc | --synchronisedScroll | Synchronised horizontal scroll |
true
,
false
|
true
| | --hc | --highlightCode | Highlight code |
true
,
false
|
true
| | --su | --summary | Show files summary |
closed
,
open
,
hidden
|
closed
| | -d | --diffStyle | Diff style |
word
,
char
|
word
| | --lm | --matching | Diff line matching type |
lines
,
words
,
none
|
none
| | --lmt | --matchWordsThreshold | Diff line matching word threshold | |
0.25
| | --lmm | --matchingMaxComparisons | Diff line matching maximum line comparisons of a block of changes |
2500
| | --hwt | --htmlWrapperTemplate | Path to custom template to be rendered when using the
html
output format |
[string]
| | -f | --format | Output format |
html
,
json
|
html
| | -i | --input | Diff input source |
file
,
command
,
stdin
|
command
| | -o | --output | Output destination |
preview
,
stdout
|
preview
| | -u | --diffy | Upload to diffy.org |
browser
,
pbcopy
,
print
| | | -F | --file | Send output to file (overrides output option) |
[string]
| | | --ig | --ignore | Ignore particular files from the diff |
[string]
| | | -v | --version | Show version number | | | | -h | --help | Show help | | |

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

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


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.