fix: switch to @dmsnell/diff-match-patch fix #378

Author: benjamine

README.md

@@ -199,10 +199,11 @@ In a browser, you can load a bundle using a tool like [esm.sh](https://esm.sh) o
 
 ## Options
 
-```tsimport * as jsondiffpatch from 'jsondiffpatch';
+```ts
+import * as jsondiffpatch from 'jsondiffpatch';
 
 // Only import if you want text diffs using diff-match-patch
-import DiffMatchPatch from 'diff-match-patch';
+import { diff_match_patch } from '@dmsnell/diff-match-patch';
 
 const jsondiffpatchInstance = jsondiffpatch.create({
   // used to match objects when diffing arrays, by default only === operator is used
@@ -219,8 +220,8 @@ const jsondiffpatchInstance = jsondiffpatch.create({
   textDiff: {
     // If using text diffs, it's required to pass in the diff-match-patch library in through this proprty.
     // Alternatively, you can import jsondiffpatch using `jsondiffpatch/with-text-diffs` to avoid having to pass in diff-match-patch through the options.
-    diffMatchPatch: DiffMatchPatch,
-    // default 60, minimum string length (left and right sides) to use text diff algorythm: google-diff-match-patch
+    diffMatchPatch: diff_match_patch,
+    // default 60, minimum string length (left and right sides) to use text diff algorithm: google-diff-match-patch
     minLength: 60,
   },
   propertyFilter: function (name, context) {

package-lock.json

@@ -43,8 +43,7 @@
     "patch"
   ],
   "dependencies": {
-    "@types/diff-match-patch": "^1.0.36",
-    "diff-match-patch": "^1.0.5"
+    "@dmsnell/diff-match-patch": "^1.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.10",

packages/jsondiffpatch/package.json

@@ -1,4 +1,4 @@
-import type dmp from 'diff-match-patch';
+import type { diff_match_patch } from '@dmsnell/diff-match-patch';
 import type DiffContext from '../contexts/diff.js';
 import type PatchContext from '../contexts/patch.js';
 import type ReverseContext from '../contexts/reverse.js';
@@ -31,7 +31,7 @@ function getDiffMatchPatch(
 ): DiffPatch | null;
 function getDiffMatchPatch(options: Options | undefined, required?: boolean) {
   if (!cachedDiffPatch) {
-    let instance: dmp;
+    let instance: diff_match_patch;
     if (options?.textDiff?.diffMatchPatch) {
       instance = new options.textDiff.diffMatchPatch();
     } else {

packages/jsondiffpatch/src/filters/texts.ts

@@ -1,4 +1,4 @@
-import type dmp from 'diff-match-patch';
+import type { diff_match_patch } from '@dmsnell/diff-match-patch';
 import type Context from './contexts/context.js';
 import type DiffContext from './contexts/diff.js';
 
@@ -10,7 +10,7 @@ export interface Options {
     includeValueOnMove?: boolean;
   };
   textDiff?: {
-    diffMatchPatch: typeof dmp;
+    diffMatchPatch: typeof diff_match_patch;
     minLength?: number;
   };
   propertyFilter?: (name: string, context: DiffContext) => boolean;

packages/jsondiffpatch/src/types.ts

@@ -1,13 +1,14 @@
-import DiffMatchPatch from 'diff-match-patch';
-import DiffPatcher from './diffpatcher.js';
-import dateReviver from './date-reviver.js';
-import type { Delta, Options } from './types.js';
+import { diff_match_patch } from '@dmsnell/diff-match-patch';
+
 import type Context from './contexts/context.js';
 import type DiffContext from './contexts/diff.js';
 import type PatchContext from './contexts/patch.js';
 import type ReverseContext from './contexts/reverse.js';
+import dateReviver from './date-reviver.js';
+import DiffPatcher from './diffpatcher.js';
+import type { Delta, Options } from './types.js';
 
-export { DiffPatcher, dateReviver };
+export { dateReviver, DiffPatcher };
 
 export type * from './types.js';
 export type { Context, DiffContext, PatchContext, ReverseContext };
@@ -19,7 +20,7 @@ export function create(
 ) {
   return new DiffPatcher({
     ...options,
-    textDiff: { ...options?.textDiff, diffMatchPatch: DiffMatchPatch },
+    textDiff: { ...options?.textDiff, diffMatchPatch: diff_match_patch },
   });
 }
 
@@ -28,7 +29,7 @@ let defaultInstance: DiffPatcher;
 export function diff(left: unknown, right: unknown) {
   if (!defaultInstance) {
     defaultInstance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch },
+      textDiff: { diffMatchPatch: diff_match_patch },
     });
   }
   return defaultInstance.diff(left, right);
@@ -37,7 +38,7 @@ export function diff(left: unknown, right: unknown) {
 export function patch(left: unknown, delta: Delta) {
   if (!defaultInstance) {
     defaultInstance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch },
+      textDiff: { diffMatchPatch: diff_match_patch },
     });
   }
   return defaultInstance.patch(left, delta);
@@ -46,7 +47,7 @@ export function patch(left: unknown, delta: Delta) {
 export function unpatch(right: unknown, delta: Delta) {
   if (!defaultInstance) {
     defaultInstance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch },
+      textDiff: { diffMatchPatch: diff_match_patch },
     });
   }
   return defaultInstance.unpatch(right, delta);
@@ -55,7 +56,7 @@ export function unpatch(right: unknown, delta: Delta) {
 export function reverse(delta: Delta) {
   if (!defaultInstance) {
     defaultInstance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch },
+      textDiff: { diffMatchPatch: diff_match_patch },
     });
   }
   return defaultInstance.reverse(delta);
@@ -64,7 +65,7 @@ export function reverse(delta: Delta) {
 export function clone(value: unknown) {
   if (!defaultInstance) {
     defaultInstance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch },
+      textDiff: { diffMatchPatch: diff_match_patch },
     });
   }
   return defaultInstance.clone(value);

packages/jsondiffpatch/src/with-text-diffs.ts

@@ -1,4 +1,4 @@
-import DiffMatchPatch from 'diff-match-patch';
+import { diff_match_patch } from '@dmsnell/diff-match-patch';
 import type { Delta, Options } from '../../src/index.js';
 
 interface Example {
@@ -580,7 +580,7 @@ const text: ExampleGroup = [
     right: largeText,
     delta: [shortText, largeText],
     reverse: [largeText, shortText],
-    options: { textDiff: { diffMatchPatch: DiffMatchPatch } },
+    options: { textDiff: { diffMatchPatch: diff_match_patch } },
   },
   {
     left: largeText,
@@ -600,13 +600,13 @@ const text: ExampleGroup = [
       2,
     ],
     exactReverse: false,
-    options: { textDiff: { diffMatchPatch: DiffMatchPatch } },
+    options: { textDiff: { diffMatchPatch: diff_match_patch } },
   },
   {
     name: 'larger than min length',
     options: {
       textDiff: {
-        diffMatchPatch: DiffMatchPatch,
+        diffMatchPatch: diff_match_patch,
         minLength: 10,
       },
     },
@@ -620,7 +620,7 @@ const text: ExampleGroup = [
     name: 'shorter than min length',
     options: {
       textDiff: {
-        diffMatchPatch: DiffMatchPatch,
+        diffMatchPatch: diff_match_patch,
         minLength: 10,
       },
     },

packages/jsondiffpatch/test/examples/diffpatch.ts

@@ -1,4 +1,4 @@
-import DiffMatchPatch from 'diff-match-patch';
+import { diff_match_patch } from '@dmsnell/diff-match-patch';
 import * as htmlFormatter from '../../src/formatters/html.js';
 import * as jsondiffpatch from '../../src/index.js';
 
@@ -10,7 +10,7 @@ describe('formatters.html', () => {
 
   beforeAll(() => {
     instance = new DiffPatcher({
-      textDiff: { diffMatchPatch: DiffMatchPatch, minLength: 10 },
+      textDiff: { diffMatchPatch: diff_match_patch, minLength: 10 },
     });
     formatter = htmlFormatter;
   });