Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
#To install:
#In your git configuration (for instance, .git/config to do it at the project level), add:
#[merge "json_merge"]
# name = A custom merge driver for json files
# driver = coffee %O %A %B
# recursive = binary
#In your project's .gitattributes file, add something like:
#*.json merge=json_merge
fs = require 'fs'
#Read in and parse the files
ancestor = JSON.parse fs.readFileSync process.argv[2]
ours = JSON.parse fs.readFileSync process.argv[3]
theirs = JSON.parse fs.readFileSync process.argv[4]
#This gets set to true if we find a conflict
conflicts = false
#Generate a node to indicate a conflict
#We include '<<<<<<<<>>>>>>>>' so that developers used to searching for <<<<
#to find conflicts can maintain their current habits
make_conflict_node = (ancestor_value, our_value, their_value, path) ->
res = {}
res['CONFLICT'] = '<<<<<<<<>>>>>>>>'
res['OURS'] = our_value ? null
res['THEIRS'] = their_value ? null
res['ANCESTOR'] = ancestor_value ? null
res['PATH'] = path.join '.'
return res
#The main merge function; we call it with the 3 json objects, and then
#it recursively calls itself. It modifies our_node with the result
#of the merge.
#Path is an array of key names indicating where we are in the object
merge = (ancestor_node, our_node, their_node, path = []) ->
#Create a set of all the keys present in either our node or their node
keys = {}
for key, _ of our_node
keys[key] = true
for key, _ of their_node
keys[key] = true
#Go through each key...
for key, _ of keys
#Get the values at that key for the three objects
ancestor_value = ancestor_node?[key]
our_value = our_node?[key]
their_value = their_node?[key]
sub_path = path.concat key
#If there's a discrepency...
if our_value isnt their_value
#if theirs matches the ancestor, go with ours
if JSON.stringify(their_value) is JSON.stringify(ancestor_value)
#no action is needed in this case
#if ours matches the ancestor, go with theirs
else if JSON.stringify(our_value) is JSON.stringify(ancestor_value)
#We write the value to our_node since we're going to overwrite
#our version with the merged version
our_node[key] = their_value
#if both ours and theirs are objects, recurse into them
else if our_value and their_value and typeof(our_value) is 'object' and typeof(their_value) is 'object'
merge ancestor_value, our_value, their_value, sub_path
#finally, if none of the above are true, report a conflict
conflicts = true
our_node[key] = make_conflict_node ancestor_value, our_value, their_value, sub_path
#Kick off the merge on the top of the json tree
#Merge modifies ours.
merge ancestor, ours, theirs
#We write the merged version of ours back to the file we got it from, which
#is what git expects us to do with the results of the merge.
#We tell JSON.stringify to pretty-print it with 4 spaces per tab.
fs.writeFileSync process.argv[3], (JSON.stringify ours, null, 4)
#If there were conflicts, we exit with an error code of 1 to tell git that
#the conflicts need manual resolution.
#Otherwise, we exit with a code of 0 to tell git that the merge was successful.
process.exit if conflicts then 1 else 0

This comment has been minimized.

Copy link
Owner Author

@jphaas jphaas commented Jun 27, 2014

An explanation of what this is about is here:


This comment has been minimized.

Copy link

@mokkabonna mokkabonna commented Nov 10, 2014

Great, I have modified it to use 2 spaces indent and with newline at the end of the file, as that is common for things like package.json etc


This comment has been minimized.

Copy link

@zijam zijam commented Sep 14, 2015

I get this following error message

SyntaxError: Unexpected end of input
  at Object.parse (native)
  at Object.<anonymous> (/root/
  at Object.<anonymous> (/root/
  at Module._compile (module.js:456:26)

And the arguments to the coffeescript script is

[ 'coffee',
  '.merge_file_zWFocu' ]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment