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

restructing the docs, still not sure...

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

40
README.md
View File

@ -2,17 +2,36 @@
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.
## Motivation
This module is a re-imagining of *UN\*X `diff`* to support JavaScript object trees in addition to flat text, outputing the result in native JSON. This was intended as a means to locate changes to rather big JSON objects/trees and store them efficiently.
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
- Well defined and human readable [*diff* format](#the-diff-format)
- [JSON](https://www.json.org/) *diff* support
- JavaScript object *diff* support including objects/types not supported in JSON
- ~~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
- [Patterns](#patterns) as a means to simplify structural comparison/testing
- [Configurable and extensible](#extending-diff) implementation
For a walkthrough by example see the [introduction](#introduction), for general documentation start at the [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)
- [Motivation](#motivation)
- [Features](#features)
- [Introduction](#introduction) - [Introduction](#introduction)
- [Seeing the difference (*diff*)](#seeing-the-difference-diff) - [Seeing the difference (*diff*)](#seeing-the-difference-diff)
- [Applying changes (*patch*)](#applying-changes-patch) - [Applying changes (*patch*)](#applying-changes-patch)
- [Partial patching](#partial-patching) - [Partial patching](#partial-patching)
- [Checking](#checking) - [Checking](#checking)
- [Generic ways to compare objects (*patterns*)](#generic-ways-to-compare-objects-patterns) - [Generic ways to compare objects (*patterns*)](#generic-ways-to-compare-objects-patterns)
- [Motivation](#motivation)
- [Features](#features)
- [Installation and loading](#installation-and-loading) - [Installation and loading](#installation-and-loading)
- [Diff](#diff) - [Diff](#diff)
- [Diff class API](#diff-class-api) - [Diff class API](#diff-class-api)
@ -231,23 +250,6 @@ cmp(Bill, BILL_or_TED_L) // -> true
*Now for the serious stuff...* *Now for the serious stuff...*
## Motivation
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).
### Features
- Well defined and human readable [*diff* format](#the-diff-format)
- [JSON](https://www.json.org/) *diff* support
- JavaScript object *diff* support including objects/types not supported in JSON
- ~~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
- [Patterns](#patterns) as a means to simplify structural comparison/testing
- [Configurable and extensible](#) implementation
XXX alternatives
## Installation and loading ## Installation and loading