JSPM

cli-diff

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4169
  • Score
    100M100P100Q109677F
  • License MIT

A diff utility with highlighted output for CLIs

Package Exports

  • cli-diff

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cli-diff) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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