flynx/diff.js
1
0
Fork 0
mirror of https://github.com/flynx/diff.js.git synced 2025-10-29 02:50:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

tweaking...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2018-09-25 23:29:28 +03:00
parent 9747f08057
commit 37a4791916
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,8 +1,8 @@
# Object diff # Object diff
*Object diff* is a not-so-basic diff/patch/pattern/compare implementation for JavaScript objects / object trees. Object diff is a *not-so-basic* diff/patch/pattern/compare implementation for JavaScript objects / object trees.
For a walkthrough by example see the [introduction](#introduction), for the general docs start at [motivation](#motivation) section or look through the index below. For a walkthrough by example see the [introduction](#introduction), for general documentation start at the [motivation](#motivation) section or look through the index below.
- [Object diff](#object-diff) - [Object diff](#object-diff)
- [Introduction](#introduction) - [Introduction](#introduction)
@ -71,16 +71,19 @@ var Diff = require('object-diff').Diff
var diff = Diff(Bill, Ted) var diff = Diff(Bill, Ted)
``` ```
Here's how different `Bill` and `Ted` really are (the *diff* format): Here's how different `Bill` and `Ted` really are (in *diff* format):
```javascript ```javascript
// log out the relevant part... // log out the relevant part...
//JSON.stringify(diff.diff, null, '\t') //JSON.stringify(diff.diff, null, '\t')
[ [
// each element of the array is a change... // each element of the diff array is a change...
{ {
// the path tells us how to reach the change location... // the path tells us how to reach the change's location
// in the source object...
"path": ["name"], "path": ["name"],
// A and B are the states before/after the change...
// A and B are the different states in the two input
// objects respectively...
"A": "Bill", "A": "Bill",
"B": "Ted" "B": "Ted"
}, },
@ -92,6 +95,7 @@ Here's how different `Bill` and `Ted` really are (the *diff* format):
{ {
// note this path, we'll explain it a bit later... // note this path, we'll explain it a bit later...
"path": ["skills", [[2, 0], [2, 1]]], "path": ["skills", [[2, 0], [2, 1]]],
// also note that either A or B can be omited... // also note that either A or B can be omited...
"B": [ "B": [
"guitar" "guitar"
@ -148,7 +152,7 @@ Since we applied *all* the changes to `Bill2`, now he is just another `Ted` (or
### Partial patching ### Partial patching
Sometimes we need to apply only a subset of the changes. So lets just *patch* `Bill`'s skillset... Sometimes we need to apply only a subset of the changes. Here we will *patch* only `Bill`'s skillset...
```javascript ```javascript
diff diff
@ -229,15 +233,15 @@ cmp(Bill, BILL_or_TED_L) // -> true
## Motivation ## Motivation
Originally this module was designed/written as a way to locate and store only the changed parts of rather big JSON objects/trees. Originally this module was designed/written as a means to locate and store only the changed parts of rather big JSON objects/trees.
The specific use cases (*[ImageGrid](https://github.com/flynx/ImageGrid) and [pWiki](https://github.com/flynx/pWiki)*) required additional features not provided by the available at the time alternative implementations (listing in next section). The specific use cases (*[ImageGrid](https://github.com/flynx/ImageGrid) and [pWiki](https://github.com/flynx/pWiki)*) required additional features not provided by the available at the time alternative implementations (listing in next section).
### Features ### Features
- [Well defined *diff* format](#the-diff-format) - Well defined and human readable [*diff* format](#the-diff-format)
- JSON *diff* support - [JSON](https://www.json.org/) *diff* support
- JavaScript object support including objects/types not supported in JSON - JavaScript object *diff* support including objects/types not supported in JSON
- ~~Optional attribute order support~~ (not done yet)
- ~~Support *new* Javascript containers: Map, Set, ...etc.~~ (feasibility testing) - ~~Support *new* Javascript containers: Map, Set, ...etc.~~ (feasibility testing)
- ~~Optional attribute order support~~ (not done yet)
- [Text diff](#extended-text-object-support) (multi-line strings) support - [Text diff](#extended-text-object-support) (multi-line strings) support
- [Patterns](#patterns) as a means to simplify structural comparison/testing - [Patterns](#patterns) as a means to simplify structural comparison/testing
- [Configurable and extensible](#) implementation - [Configurable and extensible](#) implementation