Search packages, repositories and app categories

Package detailsv0.2.1

json_diff

Utilities for diffing two JSON objects

AndroidiOSWebmacOSWindowsLinux
30-day downloads
14K
Likes
25
Pub points
130

Install package

flutter pub add json_diff

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Flutter/Dart package that provides utilities for comparing two JSON objects and generating a detailed diff. It identifies additions, deletions, and modifications between the structures, making it ideal for tracking changes in JSON data. The package supports nested objects and arrays, offering clear, structured output to help developers understand differences programmatically. Designed for cross-platform use, it works seamlessly across Android, iOS, Web, macOS, Windows, and Linux. The library is lightweight and integrates easily with existing Dart projects.

Use cases

  • Comparing API responses
  • Tracking configuration changes
  • Debugging JSON updates
  • Versioning JSON data
  • Real-time data synchronization
  • Validating data integrity

Key features

  • Nested object comparison
  • Array difference detection
  • Clear diff output format
  • Cross-platform compatibility
  • Lightweight and fast
  • Supports null and primitive values

Suitable for

  • Developers working with dynamic JSON
  • Apps requiring change tracking
  • Tools for data validation
  • Debugging and testing workflows
  • Real-time collaboration features

Considerations

  • May not handle circular references
  • Large JSON may impact performance
  • Output format requires parsing
  • Limited customization of diff logic
  • Not designed for binary data
  • Requires manual handling of complex types

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Build Status

Generate a diff between two JSON strings.

Usage

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

import 'package:json_diff/json_diff.dart';

final left = {"a": 2, "b": 3, "c": 5, "d": {"x": 4, "y": 8}};
final right = {"b": 7, "c": 5, "d": {"x": 4, "z": 16}, "e": 11};
final differ = JsonDiffer.fromJson(left, right);
DiffNode diff = differ.diff();
print(diff.added);              // => {"e": 11}
print(diff.removed);            // => {"a": 2}
print(diff.changed);            // => {"b": [3, 7]}
print(diff.node);               // => a Map<String,DiffNode>
print(diff.node['d']);          // => a DiffNode
print(diff.node['d'].added);    // => {"z": 16}
print(diff.node['d'].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 moved property, which is a Map of indexes, where key is the original index of an element, and value is index in the changed list.
  • 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.
  • a path property, which is a List of indexes, describing the path from the root where this DiffNode is operating.

Contributing

Contributions welcome! Please read the contribution guidelines.

Disclaimer

This is not an official Google product.

Categories

Dependencies

Dependency list 2 items

Source repository

Projects using this package

No data available yet.