Miss any of our Open RFC calls?Watch the recordings here! »

onp

1.0.2 • Public • Published

ONP ONP

Pipeline Npm Downloads License Node Collaborators

What is it?

Text diff algorithm based on 'An O(NP) Sequence Comparison Algorithm' from Sun Wu, Udi Manber and Gene Myers. This is implementation of this algorithm wrapped into typescript and UMD module. This module is also able compare array of items with method .toString() and keep original objects and instances. It's has really simple API.

Install

With npm do:

npm install onp

API for compare

diffText(a: string, b: string): DiffText

This method take 2 string and make compare of these strings. It returns object with lcs property, that is contains "longest common subsequence" text, distance property that represents "Levenshtein distance" and results property that contains array with string and state (1, 0, -1)

diffArray<T>(a: Array<T>, b: Array<T>): DiffArray<T>

This method take 2 array of objects, that has implemented method .toString() and make compare of these objects based on .toString() result. This method try to keep instances of objects as valid as possible. It returns object with lcs property, that is contains "longest common subsequence" text, distance property that represents "Levenshtein distance" and results property that contains array with items of T and state (1, 0, -1)

Typescript usage example
import {diffText} from "onp";
const results = diffText("Text A", "Text B");
 
console.log(results.distance);
//2
console.log(results.lcs);
//"Text "
console.log(results.results);
//[
// { data: 'Text ', state: 0 },
// { data: 'A', state: -1 },
// { data: 'B', state: 1 } 
//]
Javascript usage example
const diffText = require("onp").diffText;
const results = diffText("Text A", "Text B");
 
console.log(results.distance);
//2
console.log(results.lcs);
//"Text "
console.log(results.results);
//[
// { data: 'Text ', state: 0 },
// { data: 'A', state: -1 },
// { data: 'B', state: 1 } 
//]
const results = onp.diffText("Text A", "Text B");
 
console.log(results.distance);
//2
console.log(results.lcs);
//"Text "
console.log(results.results);
//[
// { data: 'Text ', state: 0 },
// { data: 'A', state: -1 },
// { data: 'B', state: 1 } 
//]

Examples

Live example with text diff, click on image to run CodePen

Text Diff

Donate me 😉

QR Paypal

License

MIT - MIT License

Install

npm i onp

DownloadsWeekly Downloads

5

Version

1.0.2

License

MIT

Unpacked Size

14.3 kB

Total Files

10

Last publish

Collaborators

  • avatar