cli-diff

A diff utility with highlighted output for CLIs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cli-diff
301.0.04 years ago4 years agoMinified + gzip package size for cli-diff in KB

Readme

cli-diff
cli-diff on npm MIT Licensed Supported Node versions Build status Coverage via Codecov types: TypeScript standard-readme compliant
A diff utility with highlighted output for CLIs

cli-diff makes it easy for your CLI or script to output a highlighted diff. It doesn’t support syntax highlighting in the diff right now, but it does support highlighting line-by-line.

Table of Contents

Install

$ yarn add cli-diff
$ # or npm:
$ npm install cli-diff

Usage

import diff from 'cli-diff'
// or, if you prefer:
const diff = require('cli-diff').default

console.log(diff('hello', 'goodbye'))
/* output:
@@ -1,1 +1,1 @@
-hello
\ No newline at end of file
+goodbye
*/

console.log(
  diff(
    { name: 'old.txt', content: 'hello\nworld\n' },
    { name: 'new.txt', content: 'Hello, world!\n' }
  )
)
/* output:
--- old.txt
+++ new.txt
@@ -1,2 +1,1 @@
-hello
-world
+Hello, world!
*/

Maintainers

@j-f1

Contribute

PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2018 Jed Fox