@penrose-labs/diff-htmls
v0.0.2TypeScript
Fork of [html-diff-ts](https://github.com/ericmakesapps/html-diff-ts), which is a TypeScript port of [HtmlDiff.NET](https://github.com/Rohland/htmldiff.net) which is itself a C# port of the Ruby implementation, [HtmlDiff](https://github.com/myobie/htmldif
131/weekUpdated 3 weeks agoISCUnpacked: 218.4 KB
Published by lukezeller
npm install @penrose-labs/diff-htmlsDiff HTML
This is originally a fork of
html-diff-ts, which is a TypeScript port
of HtmlDiff.NET which is itself a C# port of
the Ruby implementation, HtmlDiff.
The purpose of this fork was to fix the handling of overlapping blocks. For example, if
diffing URLs, I want them to not be broken up, but also I want img tags to not be broken
up. However, imgs contain URLs in the href, which throws an error. This fixes that.
Roadmap
This will also fix the weird word-by-word result that this package gives. It's technically
correct, but a better user experience would be collapsing sequential changes.
Installation
npm i diff-htmls
Project Description
Comparing two HTML blocks, and returns a meshing of the two that includes andins.diffins for new code,del.diffdel for removed code, and del.diffmod and ins.diffmod for sections of code
that have been changed.
For "special tags" (primarily style tags such as and ), ins.mod
elements are inserted with the new styles.
API
Options:
- blocksExpression - list of Regular Expressions which will be countes as one block
(token) instead of dividing it on parts by default mechanism (better see example)
- exp - Regular Expression for token itself
- compareBy - Regular Expression for part of the token by which will be comparison
made
Usage
$3
``typescript
import diff from "diff-htmls"
const oldHtml = "
Some old html here
"const newHtml = "
Some new html goes here
"const result = diff(oldHtml, newHtml)
`
Result:
`html`
Some old >new html here
Visualization:
`diff`
Some
- old
+ new
html here
$3
The tokenizer works by running the diff on words, but sometimes this isn't ideal. For example, it may look clunky when a date is edited from 12 Jan 2022 to 14 Feb 2022. It might be neater to treat the diff on the entire date rather than the independent tokens.
You can achieve this using AddBlockExpression. Note, the Regex example is not meant to be exhaustive to cover all dates. If text matches the expression, the entire phrase is included as a single token to be compared, and that results in a much neater output.
`typescript
import diff from "diff-htmls"
const oldHtml = "
12.11.2022
"const newHtml = "
15.12.2022
"const dateRegexp = /\d\d\.\d\d\.\d\d\d\d/gm
const result = (oldHtml, newHtml, { blocksExpression: [{ exp: dateRegexp }] })
`
Result:
`html
12.11.2022 15.12.2022
`
Visualization:
diff
- 12.11.2022
+ 15.12.2022
`$3
No diff
typescript
import diff from "diff-htmls"// "src" attr is different but "title" - is the same
const oldHtml = '
'
// "src" attr is different but "title" - is the same
const newHtml = '
'
const result =
(oldHtml,
newHtml,
{
blocksExpression: [
{
// match ![]()
tag
exp: /
// compare only by title="" attribute
compareBy: /title="[\w\W]+?"/g
}
]
})
`Result:
Will return the new string without comparison to old one - because title attribute is the
same
html
`Has diff
typescript
import diff from "diff-htmls"// "title" attr is different
const oldHtml = ''
// "title" attr is different
const newHtml = ''
const result =
(oldHtml,
newHtml,
{
blocksExpression: [
{
// match ![]()
tag
exp: /
// compare only by title="" attribute
compareBy: /title="[\w\W]+?"/g
}
]
})
`Result:
Will return the new string with diff to old one - because title attribute has changed
html
`Visualization:
diff
-
+
``