Releases · benjamine/jsondiffpatch

Breaking changes

This package is now pure ESM. For more info, please read Sindre Sorhus's FAQ (#350).
Supported Node versions are ^18.0.0 || >=20.0.0 (#350).
Requires ES6 support (#350).
There is no longer a default export. Import this package by using import * as jsondiffpatch from 'jsondiffpatch' or by importing individual methods (#350).
Formatters are no longer exported from the main entry-point and must be imported from subpaths (#350):
- import * as annotatedFormatter from 'jsondiffpatch/formatters/annotated'
- import * as baseFormatter from 'jsondiffpatch/formatters/base'
- import * as consoleFormatter from 'jsondiffpatch/formatters/console'
- import * as htmlFormatter from 'jsondiffpatch/formatters/html'
- import * as jsonpatchFormatter from 'jsondiffpatch/formatters/jsonpatch'
Updated CSS imports (#350):
- import 'jsondiffpatch/formatters/styles/html.css'
- import 'jsondiffpatch/formatters/styles/annotated.css'
The main entry-point no longer includes text diffing by default. Either pass in the diff-match-patch library via the textDiff.diffMatchPatch option, or use the jsondiffpatch/with-text-diffs entry point that is included for convenience (#352).
Context.switchTo() has been removed (#345).
BaseFormatter.typeFormattterErrorFormatter() now throws an error instead of returning a string (#345).
The UMD browser bundle has been removed. If you were using a script tag to include jsondiffpatch in your project, you can now import it inside of your main script tag as show below. For a more complete example, see the Visual Diff example before and after this change.

<!doctype html>
<html>
  <head>
    <link
      rel="stylesheet"
      href="https://esm.sh/[email protected]/lib/formatters/styles/html.css"
      type="text/css"
    />
    <link
      rel="stylesheet"
      href="https://esm.sh/[email protected]/lib/formatters/styles/annotated.css"
      type="text/css"
    />
  </head>
  <body>
    <script type="module">
      import * as jsondiffpatch from 'https://esm.sh/[email protected]';
      import * as annotatedFormatter from 'https://esm.sh/[email protected]/formatters/annotated';
      import * as htmlFormatter from 'https://esm.sh/[email protected]/formatters/html';

      ...
    </script>
  </body>
</html>