JSON Diff

Generate a diff between two JSON strings.

Usage

Here's a basic example which features a deleted object, a new object, and a changed object:

import 'package:json_diff/json_diff.dart';

Map<String,Object> left = '{"a": 2, "b": 3, "c": 5, "d": {"x": 4, "y": 8}}';
Map<String,Object> right = '{"b": 7, "c": 5, "d": {"x": 4, "z": 16}, "e": 11}';
differ = new JsonDiffer(left, right);
DiffNode diff = differ.diff();
diff.added              // => {"e": 11}
diff.removed            // => {"a": 2}
diff.changed            // => {"b": [3, 7]}
diff.node               // => a Map<String,DiffNode>
diff.node['a']          // => a DiffNode
diff.node['a'].added    // => {"z": 16}
diff.node['a'].removed  // => {"y": 8}

So that's pretty fun. So when you diff two JSON strings, you get back a DiffNode. A DiffNode is a heirarchical structure that vaguely mirrors the structure of the input JSON strings. In this example, the top-level DiffNode we got back has

  • an added property, which is a Map of top-level properties that were not found in left, and were found in right.

  • a removed property, which is a Map of top-level properties that were found in left, but were not found in right.

  • a changed property, which is a Map of top-level properties whose values are different in left and in right. The values in this Map are two-element Arrays. The 0th element is the old value (from left), and the 1st element is the new value (from right).

  • a node property, a Map of the properties found in both left and right that have deep differences. The values of this Map are more DiffNodes.

Contributing

Contributions welcome! Please read the contribution guidelines.

Disclaimer

This is not an official Google product.

Libraries

json_diff