https://github.com/sanity-io/mendoza
Differ for structured documents (JSON)
https://github.com/sanity-io/mendoza
Last synced: 8 months ago
JSON representation
Differ for structured documents (JSON)
- Host: GitHub
- URL: https://github.com/sanity-io/mendoza
- Owner: sanity-io
- License: mit
- Created: 2020-01-20T15:27:33.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T09:41:33.000Z (about 1 year ago)
- Last Synced: 2025-10-02T06:56:48.773Z (9 months ago)
- Language: Go
- Homepage:
- Size: 73.2 KB
- Stars: 270
- Watchers: 28
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - mendoza - io | 209 | (Go)
README
# Mendoza, differ for structured documents
Mendoza looks at two structured documents, referred to as _left_ and _right_, and constructs a _patch_ of the differences.
By having the left document and the patch you'll be able to recover the right document.
Mendoza is designed for creating a _minimal_ patch, not necessarily a _readable_ patch.
Example:
```
$ cat left.json
{"name": "Bob Bobson", "age": 30, "skills": ["Go", "Patching", "Playing"]}
$ cat right.json
{"firstName": "Bob Bobson", "age": 30, "skills": ["Diffing", "Go", "Patching"]}
$ dozadiff left.json right.json
[19,1,10,1,14,"firstName",11,2,20,"Diffing",21,0,2,15]
```
**Features / non-features:**
- Lightweight JSON format.
- Flexible format which can accommodate more advanced encodings in the future.
- Differ/patcher available as a Go library (this repo).
- Patcher available as a JavaScript library: [mendoza-js](https://github.com/sanity-io/mendoza-js).
- Efficient handling of renaming of fields.
- Efficient handling of reordering of arrays.
- Not designed to be human readable.
- The patch can only be applied against the exact same version.
**Format**: See [docs/format.adoc](docs/format.adoc)