npmpackage.info

Gathering detailed insights and metrics for diff2html-cli

Other packages similar to diff2html-cli

diff2html

3.4.48

Fast Diff to colorized HTML

@nullcc/diff2html-cli

5.9.1

Fast Diff to colorized HTML

ngx-diff2html

0.1.3

A text diff component library for Angular.

@mcarey1590/ngx-diff2html

1.0.0

A text diff component library for Angular.

Gathering detailed insights and metrics for diff2html-cli

diff2html-cli

Pretty diff to html javascript cli (diff2html-cli)

5.2.15

537

MIT

TypeScript

1,643,503 3.7

Installations

npm install diff2html-cli

Pull Requests

Open

4

Total

126

Closed

19

Merged

103

Issues

Open

7

Total

50

Closed

43

Releases

Add file viewed checkbox option to cli

5.2.4

Published on 03 Jun 2022

Fix title cli option

5.2.3

Published on 03 Jun 2022

Add missing diff2html configurations to cli

5.2.0

Published on 18 Jan 2022

Bump dependencies

5.1.2

Published on 24 Jul 2020

Fix ignore option

5.1.1

Published on 09 May 2020

Bump diff2html library dependency

5.0.0

Published on 05 Feb 2020

View all 37 releases

Developer

rtfpessoa

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=16

Typescript Support

Yes

Node Version

NPM Version

Statistics

537 Stars

362 Commits

50 Forks

9 Watching

8 Branches

12 Contributors

Updated on 25 Nov 2024

Languages

TypeScript (91.54%)

JavaScript (5.81%)

HTML (2.47%)

Shell (0.18%)

Total Downloads

Cumulative downloads

Total Downloads

1,643,503

Last day

44.9%

4,797

Compared to previous day

Last week

6.9%

20,467

Compared to previous week

Last month

0.9%

89,472

Compared to previous month

Last year

185.9%

736,319

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

diff2html-cli

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

Features
Online Example
Distributions
Setup
Usage
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

Setup

1npm 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`
--fct	--fileContentToggle	Adds a viewed checkbox to toggle file content	`true`, `false`	`true`
--sc	--synchronisedScroll	Synchronised horizontal scroll	`true`, `false`	`true`
--hc	--highlightCode	Highlight code	`true`, `false`	`true`
--cs	--colorScheme	Color scheme	`auto`, `dark`, `light`	`auto`
--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`
	--diffMaxChanges	Number of changed lines after which a file diff is deemed as too big and not displayed
	--diffMaxLineLength	Number of characters in a diff line after which a file diff is deemed as too big and not displayed
	--renderNothingWhenEmpty	Render nothing if the diff shows no change in its comparison		`false`
	--maxLineSizeInBlockForComparison	Maximum number of characters of the bigger line in a block to apply comparison		`200`
	--maxLineLengthHighlight	Maximum number of characters in a line to apply highlight		`10000`
--hwt	--htmlWrapperTemplate	Path to custom template to be rendered when using the `html` output format	`[string]`
-t	--title	Page title for `html` output	`[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 <head> tag

1<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/github.min.css" />
2<!--diff2html-css-->
3<!--diff2html-js-ui-->
4<script>
5  document.addEventListener('DOMContentLoaded', () => {
6    const targetElement = document.getElementById('diff');
7    const diff2htmlUi = new Diff2HtmlUI(targetElement);
8    //diff2html-fileListToggle
9    //diff2html-synchronisedScroll
10    //diff2html-highlightCode
11  });
12</script>

Inside the <body> tag

1<div id="diff">
2  <!--diff2html-diff-->
3</div>

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

Thanks

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Security-Policy

Determines if the project has published a security policy.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:93: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-publish.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/rtfpessoa/diff2html-cli/test-and-publish.yml/master?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to diff2html-cli

Other packages similar to diff2html-cli

diff2html-cli

Installations

Pull Requests

4

126

19

103

Issues

7

50

43

Releases

Developer

Developer Guide

ESM

>=16

Yes

Statistics

Languages

Total Downloads

1,643,503

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

diff2html-cli

Table of Contents

Features

Online Example

Distributions

Setup

Usage

Exit Status Codes

Custom HTML wrapper template

Examples

Contribute

Developing

License

Thanks

10

10

10

5

4

1

0

0

0

0

0

0

3.7

/10