README.md

node-diff-utility

Compares two files using the system's diff utility, and returns the output as structured JS objects.

Usage:

var diff = require('diff-utility');
diff(filename1, filename2)
  .on('diff', function (obj) {
    console.log(obj);
  })
  .on("error", function(error) {
    console.log("Error: " + error);
  })
  .on("end", function() {
    console.log("Done!");
  });

Example

This example shows the output of node-diff-utility comparing two ndjson files, file1 and file2.

Contents of file1:

{"id": 1, "name": "Amsterdam", "type": "place"}
{"id": 2, "name": "Utrecht", "type": "place"}
{"id": 3, "name": "Rotterdam", "type": "place"}

Contents of file2:

{"id": 1, "name": "Amsterdam", "type": "place"}
{"id": 3, "name": "Rotterdam", "type": "place"}
{"id": 4, "name": "Den Haag", "type": "place"}
{"id": 5, "name": "Eindhoven", "type": "place"}

Output:

{ change: 'delete',
  line: 2,
  type: 'out',
  str: '{"id": 2, "name": "Utrecht", "type": "place"}' }

{ change: 'add',
  line: 3,
  type: 'in',
  str: '{"id": 4, "name": "Den Haag", "type": "place"}' }

{ change: 'add',
  line: 4,
  type: 'in',
  str: '{"id": 5, "name": "Eindhoven", "type": "place"}' }

Original output of system's diff utility:

$ diff file1 file2
2d1
< {"id": 2, "name": "Utrecht", "type": "place"}
3a3,4
> {"id": 4, "name": "Den Haag", "type": "place"}
> {"id": 5, "name": "Eindhoven", "type": "place"}