Skip to content

Instantly share code, notes, and snippets.

@oscherler
Last active August 28, 2024 14:40
Show Gist options
  • Save oscherler/22eb60eb78a4e4e89e0506578e8b820a to your computer and use it in GitHub Desktop.
Save oscherler/22eb60eb78a4e4e89e0506578e8b820a to your computer and use it in GitHub Desktop.
Diff JSON in Git using gron

jsondiff: diff JSON in Git using gron

gron is an incredible tool that makes JSON greppable. But it also makes it diffable, which is great if you have JSON files in Git.

To use gron to diff JSON in Git, save the json-diff script below and make it executable. Then add a difftool as shown in gitconfig, and optionally create an alias to invoke it more easily. Then try it:

git init
echo '{"foo":42,"bar":"hello"}' > foo.json
git add foo.json && git commit -m 'Initial commit.'
echo '{"foo":43,"bar":"hello"}' > foo.json
git jdiff

will give you:

--- a/foo.json
+++ b/foo.json
@@ -1,3 +1,3 @@
 json = {};
 json.bar = "hello";
-json.foo = 42;
+json.foo = 43;
[difftool "jsondiff"]
cmd = "/path/to/json-diff $LOCAL $REMOTE"
[alias]
jdiff = difftool -t jsondiff -y
#!/bin/zsh
# gron: https://github.com/tomnomnom/gron
GRON=/usr/local/bin/gron
DIFF=/usr/bin/diff
# colordiff: https://www.colordiff.org
COLORDIFF=/usr/bin/colordiff
# use colordiff in interactive mode, diff otherwise
if [ -t 1 ]
then
DIFFER=${COLORDIFF}
else
DIFFER=${DIFF}
fi
LOCAL="$1"
REMOTE="$2"
"${DIFFER}" -u --label "a/$REMOTE" --label "b/$REMOTE" <( "$GRON" < "$LOCAL" ) <( "$GRON" < "$REMOTE" ) | less
@oscherler
Copy link
Author

@lukestanley Seems legit, and very simple indeed. My solution is based on writing json-diff first, and only later thinking of using it with git, so that’s why it’s probably more complicated than needed. Thanks for the heads up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment