https://github.com/lukascivil/json-difference
A simple way to find the difference between two objects or json diff
https://github.com/lukascivil/json-difference
diff javascript json object structured-data
Last synced: 10 months ago
JSON representation
A simple way to find the difference between two objects or json diff
- Host: GitHub
- URL: https://github.com/lukascivil/json-difference
- Owner: lukascivil
- License: mit
- Created: 2018-09-21T03:16:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T04:50:46.000Z (about 1 year ago)
- Last Synced: 2025-03-28T14:05:50.764Z (11 months ago)
- Topics: diff, javascript, json, object, structured-data
- Language: TypeScript
- Homepage: https://lukascivil.github.io/json-difference/
- Size: 6.73 MB
- Stars: 57
- Watchers: 3
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JsonDifference
[](https://img.shields.io/npm/dt/json-difference.svg)
[](https://www.npmjs.com/package/json-difference 'View this project on npm')
[](https://github.com/lukascivil/json-difference/actions/workflows/cd.yml)
[](https://github.com/lukascivil/json-difference/actions/workflows/release-and-publish.yml)
[](https://www.repostatus.org/#active)
[](https://codecov.io/gh/lukascivil/json-difference)
[](https://github.com/lukascivil/jsondiffer/blob/master/LICENSE)
Computes the difference between two objects and returns an intuitive result. No matter how big your JSON is, the diff will be returned pretty fast.
The question you should ask is: Given my old structure what was changed, removed or added to the new structure?
This repository contains two npm packages, json-difference and its cli version (json-difference-cli).
It's a very lightweight lib that costs only ðŠķ 1.95 kB â gzip: 0.79 kB.
## Live Demo
[Master (deprecated link)](http://jsondifference.lukascivil.com.br)
[Latest release (new)](https://lukascivil.github.io/json-difference/)
## Installation
```sh
yarn add json-difference
# If you want to play with the terminal version
yarn add json-difference-cli
```
Or
```html
// https://json-difference.s3.amazonaws.com/<a.b.c>/json-difference-<a.b.c>.mjs
import { getDiff } from 'https://json-difference.s3.amazonaws.com/1.16.0/json-difference-1.16.0.mjs'
```
## Example
Running example:
`yarn example {simple, stress}`
## Usage of Json Difference
Method:
`getDiff(oldStruct, newStruct)`
Returns the structural difference between `oldStruct` and `newStruct`.
Simple usage:
```ts
import { getDiff } from 'json-difference'
const coffee = { color: { color1: 'black', color2: 'brown' }, special: true }
const oil = { color: { color1: 'red', color2: 'blue' }, special2: false, especial3: [{}] }
// Get JsonDiff delta
const diff = getDiff(coffee, oil)
const diff2 = getDiff(coffee, oil, { isLodashLike: true })
console.log(diff)
console.log(diff2)
```
Output:
```json
{
"added": [
["special2", false],
["especial3", []],
["especial3/0[]", {}]
],
"removed": [["special", true]],
"edited": [
["color/color1", "black", "red"],
["color/color2", "brown", "blue"]
]
}
```
```json
{
"added": [
["special2", false],
["especial3", []],
["especial3[0]", {}]
],
"removed": [["special", true]],
"edited": [
["color.color1", "black", "red"],
["color.color2", "brown", "blue"]
]
}
```
## Usage of Json Difference CLI
```sh
# jd -> Json Difference command
# -o -> Original or old struct
# -m -> Modified or new struct
jd -o "{}" -m "[]"
```
### Delta
The delta is an object that contains three properties that follow a pattern. This pattern will be shown below:
| Operation | Pattern |
| ------------- |:----------------------------------------:|
| "edited" | [path_to_the_key, old_value, new_value] |
| "added" | [path_to_the_key, value] |
| "removed" | [path_to_the_key, old_value] |
| value | Explanation |
| ------------ |:----------------------------------------------------------:|
| "__root__" | Indicates the root of the object |
| "@{}" | Indicates that the key is a non-leaf node of type Object |
| "@[]" | Indicates that the key is a non-leaf node of type Array |
### Some operations
| JSON original | JSON modified | Delta |
| ------------- |:---------------:| ------------------------------------:|
| {} | [] | "edited": [ [ "__root__", {}, [] ] ] |
| [] | {} | "edited": [ [ "__root__", [], {} ] ] |
| [{}] | [[]] | "edited": [ [ "0[]", {}, [] ] ] |
| {"a": "b"} | {"a": "c"} | "edited": [ [ "a", "b", "c" ] ] |
| {"":""} | {"": "a"} | "edited": [ [ "", "", "a" ] ] |
| {"":{"":""}} | {"": {"": "a"}} | "edited": [ [ "/", "", "a" ] ] |
| [] | [{}] | "added": [ [ "0[]", {} ] ] |
| {} | {"a":"b"} | "added": [ [ "a", "b" ] ] |
| {"a":"b"} | {} | "removed": [ [ "a", "b" ] ] |
| [{}] | [] | "removed": [ [ "0[]", {} ] ] |
| [{"":""}] | {"":""} | "added": [ [ "", "" ] ], "removed": [ [ "0[]", {} ], [ "0[]/", "" ] ], "edited": [ [ "__root__", [], {} ] ] |
It is important to understand that the output generated by the latest versions of Json Difference: [v1.9.1](https://github.com/lukascivil/json-difference/releases/tag/1.9.1) and [V1.15.7](https://github.com/lukascivil/json-difference/releases/tag/json-difference-1.15.7) is different. Version V1.15.7 introduces greater accuracy for the return.
Anyway, to request a new feature or report a problem, just open an issue and it will be investigated.