Disable text diffs by default (#352)

* Update package-lock.json

* Fix release workflow

* Use @types/diff-match-patch

* Add diffMatchPatch to options

* Add sideEffects to package.json

* Format

* Add to README

* Exclude diffMatchPatch option for with-text-diffs entry-point

* Fix bin

* Format

Author: Methuselah96

.github/workflows/release.yml

@@ -17,5 +17,6 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
       - run: npm publish
+        working-directory: ./packages/jsondiffpatch
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -187,6 +187,10 @@ In a browser, you can load a bundle using a tool like [esm.sh](https://esm.sh) o
 
 ```javascript
 import * as jsondiffpatch from 'jsondiffpatch';
+
+// Only import if you want text diffs using diff-match-patch
+import DiffMatchPatch from 'diff-match-patch';
+
 const jsondiffpatchInstance = jsondiffpatch.create({
   // used to match objects when diffing arrays, by default only === operator is used
   objectHash: function (obj) {
@@ -200,6 +204,9 @@ const jsondiffpatchInstance = jsondiffpatch.create({
     includeValueOnMove: false,
   },
   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
     minLength: 60,
   },

demos/console-demo/demo.ts

@@ -1,4 +1,4 @@
-import * as jsondiffpatch from 'jsondiffpatch';
+import * as jsondiffpatch from 'jsondiffpatch/with-text-diffs';
 import * as consoleFormatter from 'jsondiffpatch/formatters/console';
 
 const instance = jsondiffpatch.create({

demos/html-demo/demo.ts

@@ -1,4 +1,4 @@
-import * as jsondiffpatch from 'jsondiffpatch';
+import * as jsondiffpatch from 'jsondiffpatch/with-text-diffs';
 import * as annotatedFormatter from 'jsondiffpatch/formatters/annotated';
 import * as htmlFormatter from 'jsondiffpatch/formatters/html';
 

package-lock.json

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'node:fs';
+import * as jsondiffpatch from '../lib/with-text-diffs.js';
+import * as consoleFormatter from '../lib/formatters/console.js';
+
+const fileLeft = process.argv[2];
+const fileRight = process.argv[3];
+
+if (!fileLeft || !fileRight) {
+  console.log('\n  USAGE: jsondiffpatch left.json right.json');
+} else {
+  const left = JSON.parse(readFileSync(fileLeft));
+  const right = JSON.parse(readFileSync(fileRight));
+
+  const delta = jsondiffpatch.diff(left, right);
+  consoleFormatter.log(delta);
+}

packages/jsondiffpatch/bin/jsondiffpatch

@@ -7,10 +7,14 @@
     "Benjamin Eidelman <beneidel@gmail.com>"
   ],
   "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
+    "./with-text-diffs": "./lib/with-text-diffs.js",
     "./formatters/*": "./lib/formatters/*.js",
     "./formatters/styles/*.css": "./lib/formatters/styles/*.css"
   },
@@ -19,7 +23,7 @@
     "lib"
   ],
   "bin": {
-    "jsondiffpatch": "./bin/jsondiffpatch"
+    "jsondiffpatch": "./bin/jsondiffpatch.js"
   },
   "scripts": {
     "build": "tsc && ncp ./src/formatters/styles/ ./lib/formatters/styles/",
@@ -39,6 +43,7 @@
     "patch"
   ],
   "dependencies": {
+    "@types/diff-match-patch": "^1.0.36",
     "chalk": "^5.3.0",
     "diff-match-patch": "^1.0.5"
   },

packages/jsondiffpatch/bin/jsondiffpatch.js

@@ -1,4 +1,4 @@
-import dmp from 'diff-match-patch';
+import type dmp from 'diff-match-patch';
 import type DiffContext from '../contexts/diff.js';
 import type PatchContext from '../contexts/patch.js';
 import type ReverseContext from '../contexts/reverse.js';
@@ -8,13 +8,10 @@ import type {
   Filter,
   ModifiedDelta,
   MovedDelta,
+  Options,
   TextDiffDelta,
 } from '../types.js';
 
-declare global {
-  const diff_match_patch: typeof dmp | undefined;
-}
-
 interface DiffPatch {
   diff: (txt1: string, txt2: string) => string;
   patch: (txt1: string, string: string) => string;
@@ -24,42 +21,37 @@ const TEXT_DIFF = 2;
 const DEFAULT_MIN_LENGTH = 60;
 let cachedDiffPatch: DiffPatch | null = null;
 
-function getDiffMatchPatch(required: true): DiffPatch;
-function getDiffMatchPatch(required?: boolean): DiffPatch;
-function getDiffMatchPatch(required?: boolean) {
+function getDiffMatchPatch(
+  options: Options | undefined,
+  required: true,
+): DiffPatch;
+function getDiffMatchPatch(
+  options: Options | undefined,
+  required?: boolean,
+): DiffPatch | null;
+function getDiffMatchPatch(options: Options | undefined, required?: boolean) {
   if (!cachedDiffPatch) {
-    let instance: dmp | null | undefined;
-    if (typeof diff_match_patch !== 'undefined') {
-      // already loaded, probably a browser
-      instance =
-        typeof diff_match_patch === 'function'
-          ? new diff_match_patch()
-          : new (diff_match_patch as typeof dmp).diff_match_patch();
-    } else if (dmp) {
-      try {
-        instance = dmp && new dmp();
-      } catch (err) {
-        instance = null;
-      }
-    }
-    if (!instance) {
+    let instance: dmp;
+    if (options?.textDiff?.diffMatchPatch) {
+      instance = new options.textDiff.diffMatchPatch();
+    } else {
       if (!required) {
         return null;
       }
       const error: Error & { diff_match_patch_not_found?: boolean } = new Error(
-        'text diff_match_patch library not found',
+        'The diff-match-patch library was not provided. Pass the library in through the options or use the `jsondiffpatch/with-text-diffs` entry-point.',
       );
       // eslint-disable-next-line camelcase
       error.diff_match_patch_not_found = true;
       throw error;
     }
     cachedDiffPatch = {
       diff: function (txt1, txt2) {
-        return instance!.patch_toText(instance!.patch_make(txt1, txt2));
+        return instance.patch_toText(instance.patch_make(txt1, txt2));
       },
       patch: function (txt1, patch) {
-        const results = instance!.patch_apply(
-          instance!.patch_fromText(patch),
+        const results = instance.patch_apply(
+          instance.patch_fromText(patch),
           txt1,
         );
         for (let i = 0; i < results[1].length; i++) {
@@ -95,7 +87,7 @@ export const diffFilter: Filter<DiffContext> = function textsDiffFilter(
     return;
   }
   // large text, try to use a text-diff algorithm
-  const diffMatchPatch = getDiffMatchPatch();
+  const diffMatchPatch = getDiffMatchPatch(context.options);
   if (!diffMatchPatch) {
     // diff-match-patch library not available,
     // fallback to regular string replace
@@ -125,7 +117,7 @@ export const patchFilter: Filter<PatchContext> = function textsPatchFilter(
   const textDiffDelta = nonNestedDelta as TextDiffDelta;
 
   // text-diff, use a text-patch algorithm
-  const patch = getDiffMatchPatch(true).patch;
+  const patch = getDiffMatchPatch(context.options, true).patch;
   context.setResult(patch(context.left as string, textDiffDelta[0])).exit();
 };
 patchFilter.filterName = 'texts';

packages/jsondiffpatch/package.json

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