Simple string diffing. Given two strings, striff will return an object noting which characters were added or removed, and at which indices.
Run npm install striff. Or stick in on a page via CDN.
Import it, pass a couple of strings, and do whatever you want with the results.
import striff from "striff";
const result = striff("string #1", "string #2");
// {
// added: [
// ...added characters
// ],
// removed: [
// ...removed characters
// ]
// }Here's the kind of result you'll get with different types of diffing.
const str1 = "abc";
const str2 = "abcde";
const result = striff(str1, str2);{
added: [
{
character: "d",
index: 3
},
{
character: "e",
index: 4
}
],
removed: []
}const str1 = "abc";
const str2 = "a";
const result = striff(str1, str2);{
added: [],
removed: [
{
character: "b",
index: 1
},
{
character: "c",
index: 2
}
]
}Handling strings with duplicate, consecutive characters removed is a little weird. For strings whose characters were changed at the end, the indices will be grouped together at the end of the string.
const str1 = "abbbc";
const str2 = "ab";
const result = striff(str1, str2);{
added: [],
removed: [
{
character: "b",
index: 2
},
{
character: "b",
index: 3
},
{
character: "c",
index: 4
}
]
}For those whose whose characters were changed at the beginning, the indices will be grouped together at the beginning.
const str1 = "abbbc";
const str2 = "bc";
const result = striff(str1, str2);{
added: [].
removed: [
{
character: "a",
index: 0
},
{
character: "b",
index: 1
},
{
character: "b",
index: 2
}
]
}Make an issue or a pull request!