Package Health Score

72 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
5.2.15	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.11	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.2.1	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.4	\|	07/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.7.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (19,141)

GitHub Stars: 532
Forks: 50
Contributors: 20

Direct Usage Popularity

The npm package diff2html-cli receives a total of 19,141 downloads a week. As such, we scored diff2html-cli popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package diff2html-cli, we found that it has been starred 532 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the diff2html-cli repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 7
Open PR: 3
Last Release: 10 months ago
Last Commit: 10 months ago

Further analysis of the maintenance status of diff2html-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that diff2html-cli demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16

Age: 10 years
Dependencies: 5 Direct
Versions: 97
Install Size: 58.9 kB
Dist-tags: 2
# of Files: 40
Maintainers: 1
TS Typings: Yes

diff2html-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

diff2html-cli

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

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

🎉 0: Success
😵 1: Generic Error
😰 3: Input diff is empty
👮 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

<div id="diff">
  
</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.

diff2html-cli dependencies

clipboardy diff2html node-fetch open yargs

FAQs

What is diff2html-cli?

Fast Diff to colorized HTML. Visit Snyk Advisor to see a full health score report for diff2html-cli, including popularity, security, maintenance & community analysis.

Is diff2html-cli popular?

The npm package diff2html-cli receives a total of 19,141 weekly downloads. As such, diff2html-cli popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is diff2html-cli well maintained?

We found indications that diff2html-cli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is diff2html-cli safe to use?

The npm package diff2html-cli was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 November-2024, at 23:16 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (19,141)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

diff2html-cli

Table of Contents

Features

Online Example

Distributions

Setup

Usage

Exit Status Codes

Custom HTML wrapper template

Examples

Contribute

Developing

License

Thanks

diff2html-cli dependencies

diff2html-cli development dependencies

FAQs

What is diff2html-cli?

Is diff2html-cli popular?

Is diff2html-cli well maintained?

Is diff2html-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues