Jsondiffpatch Versions Save

Diff & patch JavaScript objects

v0.6.0

4 months ago

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>

Other changes

Fix demo link in formatters doc by @johnrees in https://github.com/benjamine/jsondiffpatch/pull/311
Fix the live demo link in the deltas docs by @Xheldon in https://github.com/benjamine/jsondiffpatch/pull/317
Fix typos in project documentation by @plan-do-break-fix in https://github.com/benjamine/jsondiffpatch/pull/305
Fix examples in documentation by @dayures in https://github.com/benjamine/jsondiffpatch/pull/308
Update TS type file to include jsonpatch formatter by @thilinatnt in https://github.com/benjamine/jsondiffpatch/pull/310
Fix incorrect matrix initialization by @rexxars in https://github.com/benjamine/jsondiffpatch/pull/291
Documentation instances distinction by @piomar123 in https://github.com/benjamine/jsondiffpatch/pull/129
Replace usages of substr with substring by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/343
Remove dead branches by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/344
Convert to TypeScript by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/345
Convert tests to TypeScript by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/346
Convert to monorepo and revamp build system by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/350
Disable text diffs by default by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/352

New Contributors

@johnrees made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/311
@Xheldon made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/317
@plan-do-break-fix made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/305
@dayures made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/308
@thilinatnt made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/310
@rexxars made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/291
@piomar123 made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/129

Full Changelog: https://github.com/benjamine/jsondiffpatch/compare/v0.5.0...v0.6.0

v0.5.0

8 months ago

What's Changed

Update devDependencies by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/334
- BREAKING Drops support for old browser versions like IE 8
migrate to github.io by @xamgore in https://github.com/benjamine/jsondiffpatch/pull/307
Add CI by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/333
fix: chalk platform undefined error by upgrading the version by @arjunvegda in https://github.com/benjamine/jsondiffpatch/pull/332
Add npm release workflow by @Methuselah96 in https://github.com/benjamine/jsondiffpatch/pull/336

New Contributors

@xamgore made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/307
@Methuselah96 made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/333
@arjunvegda made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/332

Full Changelog: https://github.com/benjamine/jsondiffpatch/compare/v0.4.1...v0.5.0

v0.4.1

8 months ago

What's Changed

Fix typescript typings by @benjamine in https://github.com/benjamine/jsondiffpatch/pull/279

Full Changelog: https://github.com/benjamine/jsondiffpatch/compare/v0.4.0...v0.4.1

v0.4.0

8 months ago

What's Changed

BREAKING Dropp support for node < 8 by @benjamine in https://github.com/benjamine/jsondiffpatch/commit/b0a41f953b75c2f735a40e3eeec824070e31738b
Added missing type for create function by @mattdarveniza in https://github.com/benjamine/jsondiffpatch/pull/272
Update index.d.ts by @mrdick47 in https://github.com/benjamine/jsondiffpatch/pull/271
add methods for hiding and showing unchanged fields to types by @ilyaryabchinski in https://github.com/benjamine/jsondiffpatch/pull/270
Add HtmlFormatter typings to expose showUnchanged and hideUnchanged by @ian-craig in https://github.com/benjamine/jsondiffpatch/pull/236
Update README.md about support for JSON Patch by @aryelu in https://github.com/benjamine/jsondiffpatch/pull/238
make backtrack iterative should fix #223 by @aryelu in https://github.com/benjamine/jsondiffpatch/pull/237
Add typings for Pipe API by @ian-craig in https://github.com/benjamine/jsondiffpatch/pull/240

New Contributors

@mattdarveniza made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/272
@mrdick47 made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/271
@ilyaryabchinski made their first contribution in https://github.com/benjamine/jsondiffpatch/pull/270

Full Changelog: https://github.com/benjamine/jsondiffpatch/compare/v0.3.11...v0.4.0