3-way-diff

3-way-diff

https://github.com/lodash/lodash/blob/master/lodash.js#L11220 Note: This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. Object objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are not supported.

Structure of return object is loosely based on https://github.com/flitbit/diff

Some comparison is based on https://github.com/falsecz/3-way-merge/blob/master/test/test.coffee

Concestor comes from https://github.com/dominictarr/xdiff

Differences

Differences are reported as one or more change records. Change records have the following structure:

• kind - indicates the kind of change; will be one of the following:
  • N - indicates a newly added property/element
  • D - indicates a property/element was deleted
  • E - indicates a property/element was edited
  • C - indicates a conflicting change was made to both mine and theirs
• path - the property path (from the parent)
• parent - the value on parent
• theirs - the value on theirs (undefined if kind === 'N')
• mine - the value on mine (undefined if kind === 'D')

Options

Options object can be used to denote certain flags. Object should be replica of mine with flags set on specific keys

Example

Mine:

{ 
  key1: { 
    childKey1: { 
      key: value
    },
    childKey2: value
  },
  key2: {
    childKey1: value
  }
}

Options:

{ 
  key1: { 
    childKey1: { 
      ignoreKey: true 
    },
    ignoreOrder: true, 
  },
  key2: {
    ignoreKey: true
  }
}

Flags

• ignoreKey - Do not diff this key
• ignoreOrder - Compares arrays without maintaining order
• falsy - Allow values to be compared as falsy (0, '', false, undefined, NaN and null are equal)