Sourced fromdiff's changelog.

8.0.1

• #610Fixes types fordiffJson which were broken by 8.0.0. The new bundled types in 8.0.0 only alloweddiffJson to be passed string arguments, but it should've been possible to pass either strings or objects (and now is). Thanks to Josh Kelley for the fix.

8.0.0

• #580Multiple tweaks todiffSentences:
  • tokenization no longer takes quadratic time on pathological inputs (reported as a ReDOS vulnerability by Snyk); is now linear instead
  • the final sentence in the string is now handled the same by the tokenizer regardless of whether it has a trailing punctuation mark or not. (Previously, "foo. bar." tokenized to["foo.", " ", "bar."] but "foo. bar" tokenized to["foo.", " bar"] - i.e. whether the space between sentences was treated as a separate token depended upon whether the final sentence had trailing punctuation or not. This was arbitrary and surprising; it is no longer the case.)
  • in a string that starts with a sentence end, like "! hello.", the "!" is now treated as a separate sentence
  • the README now correctly documents the tokenization behaviour (it was wrong before)
• #581 -fixed some regex operations used for tokenization indiffWords taking O(n^2) time in pathological cases
• #595 -fixed a crash in patch creation functions when handling a single hunk consisting of a very large number (e.g. >130k) of lines. (This was caused by spreading indefinitely-large arrays to.push() using.apply or the spread operator and hitting the JS-implementation-specific limit on the maximum number of arguments to a function, as shown athttps://stackoverflow.com/a/56809779/1709587; thus the exact threshold to hit the error will depend on the environment in which you were running JsDiff.)
• #596 -removed themerge function. Previously JsDiff included an undocumented function calledmerge that was meant to, in some sense, merge patches. It had at least a couple of serious bugs that could lead to it returning unambiguously wrong results, and it was difficult to simply "fix" because it wasunclear precisely what it was meant to do. For now, the fix is to remove it entirely.
• #591 - JsDiff's source code has been rewritten in TypeScript. This change entails the following changes for end users:

  • thediff package on npm now includes its own TypeScript type definitions. Users who previously used the@types/diff npm package from DefinitelyTyped should remove that dependency when upgrading JsDiff to v8.

    Note that the transition from the DefinitelyTyped types to JsDiff's own type definitions includes multiple fixes and also removes many exported types previously used foroptions arguments to diffing and patch-generation functions. (There are now different exported options types for abortable calls - ones with atimeout ormaxEditLength that may give a result ofundefined - and non-abortable calls.) See the TypeScript section of the README for some usage tips.

  • TheDiff object is now a class. Custom extensions ofDiff, as described in the "Defining custom diffing behaviors" section of the README, can therefore now be done by writing aclass CustomDiff extends Diff and overriding methods, instead of the old way based on prototype inheritance. (Ithink code that did things the old way should still work, though!)

  • diff/lib/index.es6.js anddiff/lib/index.mjs no longer exist, and the ESM version of the library is no longer bundled into a single file.

  • TheignoreWhitespace option fordiffWords is no longer included in the type declarations. The effect of passingignoreWhitespace: true has always been to makediffWords just calldiffWordsWithSpace instead, which was confusing, because that behaviour doesn't seem properly described as "ignoring" whitespace at all. The property remains available to non-TypeScript applications for the sake of backwards compatability, but TypeScript applications will now see a type error if they try to passignoreWhitespace: true todiffWords and should change their code to calldiffWordsWithSpace instead.

  • JsDiff no longer purports to support ES3 environments. (I'm pretty sure it never truly did, despite claiming to in its README, since even the 1.0.0 release usedArray.map which was added in ES5.)

• #601 -diffJson'sstringifyReplacer option behaves more likeJSON.stringify'sreplacer argument now. In particular:
  • Each key/value pair now gets passed through the replacer once instead of twice
  • Thekey passed to the replacer when the top-level object is passed in asvalue is now"" (previously, wasundefined), and thekey passed with an array element is the array index as a string, like"0" or"1" (previously was whatever the key for the entire array was). Both the new behaviours match that ofJSON.stringify.
• #602 -diffing functions now consistently returnundefined when called in async mode (i.e. with a callback). Previously, there was an odd quirk where they would returntrue if the strings being diffed were equal andundefined otherwise.

• a5cf0db v8.0.1
• 0307063 Fix types for diffJson (#610)
• f87a74c v8.0.0 released (#607)
• 8e81ac5 Upgrade build deps to latest versions withyarn upgrade --latest (#605)
• 064eb9d Bump http-proxy-middleware from 2.0.7 to 2.0.9 (#604)
• 177a93a Rip out some generic stuff (with some broken formatting) from CONTRIBUTING.md...
• dd1c4e0 TypeScript rewrite (#591)
• 2c36f81 Fix async mode return value quirk (#602)
• c376585 Fix stringifyReplacer (#601)
• d2fb347 Stop publishing runtime.js to npm (#599)
• Additional commits viewable incompare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)