How can I visualize per-character differences in a unified diff file?
Asked Answered
M

8

163

Say I get a patch created with git format-patch. The file is basically a unified diff with some metadata. If I open the file in Vim, I can see which lines have been modified, but I cannot see which characters in the changed lines differ. Does anyone know a way (in Vim, or some other free software that runs on Ubuntu) to visualize per-character differences?

A counter example where per-character diff is visualized is when executing vimdiff a b.

update Fri Nov 12 22:36:23 UTC 2010

diffpatch is helpful for the scenario where you're working with a single file.

update Thu Jun 16 17:56:10 UTC 2016

Check out diff-highlight in git 2.9. This script does exactly what I was originally seeking.

Ministration answered 12/7, 2010 at 19:52 Comment(4)
This might be better on superuser.comShipmate
Perhaps. I chose stackoverflow.com since the FAQ mentions this is the place for questions about "software tools commonly used by programmers"Ministration
I'm not sure that this directly answers your question, but git diff --color-words is very useful for just seeing what words have change within lines, rather than the usual unified diff output. It is word-based rather than character-based, though, so if there's not much whitespace in the content you're diffing then the output may be less neat. (Edited: Oops, I see that I misunderstood what you're asking for - nevertheless maybe this comment would be useful to someone.)Partite
Related https://mcmap.net/q/66426/-how-to-improve-git-39-s-diff-highlighting/72178Junker
O
15

Given your references to Vim in the question, I'm not sure if this is the answer you want :) but Emacs can do this. Open the file containing the diff, make sure that you're in diff-mode (if the file is named foo.diff or foo.patch this happens automatically; otherwise type M-x diff-mode RET), go to the hunk you are interested in and hit C-c C-b for refine-hunk. Or step through the file one hunk at a time with M-n; that will do the refining automatically.

Otherwise answered 18/8, 2010 at 7:54 Comment(3)
Works for me! Heh, I've used Vim for 10 years, but I just installed emacs. :)Ministration
But emacs doesn't support reading from stdin, I can't do e.g. git log master.. -p | emacs -Beaut
@Beaut You could open Emacs and type M-! to run the command and capture the output in a buffer.Otherwise
C
212

In git, you can merge without committing. Merge your patch first, then do:

git diff --word-diff-regex=.

Note the dot after the equals sign.

Crenation answered 24/10, 2011 at 2:14 Comment(13)
Better: git diff --color-words=..Plea
@Plea You should make your comment an answer.Bullheaded
Upvoters please note, my original use case assumes you only have a patch file, no git repo or even base/modified versions. That's why I accepted @legoscia's answer... it describes exactly what was requested.Ministration
@Plea git diff --color-words=. and git diff --color-words . works differently. Better is git diff --color-words ..Ashburn
@abhisekp: what's the difference?Plea
@Plea Here you go i.imgur.com/Fa8vCtO.png But you're right about Better: git diff --color-words=.Ashburn
@abhisekp: thanks for the pic. I think I figured it out: the git diff --color-words . is really the same as git diff --color-words -- .! I.e., the . is interpreted as a path. You can verify with mkdir x y; echo foo > x/test; git add x/test; git commit -m test; echo boo > x/test; cd y; git diff --color-words=.; git diff --color-words .; git diff --color-words -- ..Plea
@Plea yes. That's a path. I got it. But I liked the way you presented the whole thing in a single like. Nice. +1Ashburn
No solution for git commit -p?Mosby
Works with git log too, but geez this is ugly. It surrounds differences with square brackets, and confuses whether these are part of the code or not.Beaut
@ntc2, git diff --color-words=., or similar, must be the git basis by which meld does it's char-by-char highlighting magic (see a screenshot of meld in my answer here). I've been wondering abou that for years.Greenness
If you wanted to see changes in last commit, git show --color-words=.Varve
I thought this would help me see the indentation edit nicely and it did it for few lines but then... i.imgur.com/Ksa4h7Y.pngJump
P
183

Here are some versions with less noisy output than git diff --word-diff-regex=<re> and that require less typing than, but are equivalent to, git diff --color-words --word-diff-regex=<re>.

Simple (does highlight space changes):

git diff --color-words

Simple (highlights individual character changes; does not highlight space changes):

git diff --color-words=.

More complex (does highlight space changes):

git diff --color-words='[^[:space:]]|([[:alnum:]]|UTF_8_GUARD)+'

In general:

git diff --color-words=<re>

where <re> is a regexp defining "words" for the purpose of identifying changes.

These are less noisy in that they color the changed "words", whereas using just --word-diff-regex=<re> surrounds matched "words" with colored -/+ markers.

Plea answered 3/9, 2014 at 0:29 Comment(10)
I myself like --color-words, without the =. part.Bullheaded
git diff --color-words='\w' would work better with diacritics (git v1.7.10.4)Usurious
Your more complex version works great. I appended --word-diff=plain to additionally have [- and -] surround deletions and {+ and +} surround additions. As the manual warns, though, actual occurrences of these delimiters in the source are not escaped in any wayScanlon
Your more complex version unfortunately doesn't seem to highlight e.g. indentation changes, I've opened a question on thisScanlon
This answer is great! However is there a way to actually change the background of those changes to green/red?Magda
@WoLfPwNeR: if you're asking how to make git diff change the background colors instead of the foreground colors, this might help: github.com/git/git/tree/master/contrib/diff-highlight; I have not tried it myself.Plea
@Plea Looks like it doesn't work with --color-words, but otherwise it looks nice. I'll stick with line diff then.Magda
Thanks for this great answer! Is it possible to hide lines without differences from the output?Eldenelder
@Hatshepsut: try adding -U0?Plea
More complex re does not highlight space changesBartholomeus
B
51
git diff --color-words="[^[:space:]]|([[:alnum:]]|UTF_8_GUARD)+"

The above regex (from Thomas Rast) does a decent job of separating diff fragments at the punctuation/character level (while not being as noisy as --word-diff-regex=.).

I posted a screenshot of the resulting output here.


Update:

This article has some great suggestions. Specifically, the contrib/ tree of the git repo has a diff-highlight perl script that shows fine-grained highlights.

Quick start to use it:

$ curl https://git.kernel.org/cgit/git/git.git/plain/contrib/diff-highlight/diff-highlight > diff-highlight
$ chmod u+x diff-highlight
$ git diff --color=always HEAD~10 | diff-highlight | less -R
Bondon answered 15/4, 2012 at 17:15 Comment(14)
You can shorten it to --color-words=[^[:space:]]|([[:alnum:]]|UTF_8_GUARD)+'Gessner
i had to add ' to the beginning of the value there. otherwise i got an error. Also, i simply using --color-words i get the exact same behaviour as using that regexp.Tse
@Tse what text did you test it on to get the "exact same behavior"?Bondon
@JustinM.Keyes a 4 line changes in a source file. nothing weird. javascript i think. Ascii.Tse
@Tse The text content matters. If your changes are separated by whitespace, there's no difference. But if you change if you change something like foo.bar to foo.qux you will see the difference.Bondon
Simpler: git diff --color-words='[^[:space:]]|([[:alnum:]]|UTF_8_GUARD)+'.Plea
@Plea Cool, thanks. Any idea if that is backwards compatible with say git 1.7.x?Bondon
No idea when this feature was introduced; saw it when reading man git diff to understand what your answer was doing. Also, looks like my point is the same as @Eddfied's in the first comment :PPlea
I wanna give a shoutout to @ntc2, that is exactly what I was looking for when googling "git diff by character"!Dysphasia
I'm getting a strange newline issue using this vs just --color-words=.. On some lines using this regex, the diff-ed character (in my case, a # comment character that was removed in a YAML file) jumps to the beginning of the line and is no longer indented correctly. Using --color-words=. appears to show the correct indentation.Mcniel
diff-hightligh needs to be made with make atm. github.com/Homebrew/homebrew-core/issues/…Mandalay
URL is not available.Mosby
I had installed git with Homebrew and already had that script at /usr/local/share/git-core/contrib/diff-highlight/diff-highlight . This seems to suggest that Homebrew's git does install the entire contrib in /usr/local/share/git-core/contrib/. So finally, the following worked for me git diff --color=always | /usr/local/share/git-core/contrib/diff-highlight/diff-highlightLandin
Note that diffr sees itself as improved version of diff-highlightRainproof
O
15

Given your references to Vim in the question, I'm not sure if this is the answer you want :) but Emacs can do this. Open the file containing the diff, make sure that you're in diff-mode (if the file is named foo.diff or foo.patch this happens automatically; otherwise type M-x diff-mode RET), go to the hunk you are interested in and hit C-c C-b for refine-hunk. Or step through the file one hunk at a time with M-n; that will do the refining automatically.

Otherwise answered 18/8, 2010 at 7:54 Comment(3)
Works for me! Heh, I've used Vim for 10 years, but I just installed emacs. :)Ministration
But emacs doesn't support reading from stdin, I can't do e.g. git log master.. -p | emacs -Beaut
@Beaut You could open Emacs and type M-! to run the command and capture the output in a buffer.Otherwise
P
7

If you have nothing against installing NodeJS, there's a package called "diff-so-fancy" (https://github.com/so-fancy/diff-so-fancy), which is very easy to install and works perfectly:

npm install -g diff-so-fancy
git diff --color | diff-so-fancy | less -R

Edit: Just found out it's actually a wrapper for the official diff-highlight... At least it's easier to install for perlophobes like me and the GitHub page is nicely documented :)

Philbrick answered 2/7, 2017 at 11:24 Comment(0)
A
2

Am not aware of per character difference tool, but there is a per word difference tool: wdiff.

refer examples Top 4 File Difference Tools on UNIX / Linux – Diff, Colordiff, Wdiff, Vimdiff.

Arias answered 13/7, 2010 at 8:5 Comment(3)
wdiff is interesting, thanks! To clarify my original question, I'm looking for something that provides enhanced syntax highlighting for a single file that happens to be in unified diff format.Ministration
Slightly offtopic (about word-for-word diffs, not enhancing a preexisting diff output), but I've found the following combinations best for word-for-word visualizations: * wdiff old_file new_file | cdiff * vimdiff , then inside vim :windo wincmd K in order to switch to vertical window layout (one below the other) from the side by side one. That layout is much better for files with long lines.Kleenex
BTW, Some other tools worth checking out, not mentioned in the linked article: wdiff2, mdiff, and the Google's online tool.Kleenex
M
1

After a little research, I notice this question has come up twice recently on the main Vim mailing list. The NrrwRgn plugin was mentioned both times (make two narrow regions and diff them). Using NrrwRgn as described by Christian Brabandt feels more like a workaround than a solution, but maybe that's good enough.

I tried out NrrwRgn and it, together with :diffthis, was indeed useful for illustrating per-character differences within parts of a single file. But it took many keystrokes. My Vimscript is pretty rusty, but it could likely be scripted. Maybe NrrwRgn could be enhanced to provide the desired functionality.

Thoughts?

Ministration answered 13/7, 2010 at 3:58 Comment(0)
R
0

diffr is my tool of choice now.

example diff

Installation on Windows:

  1. winget install -e --id Rustlang.Rustup
  2. cargo install diffr
  3. git config --global core.pager "diffr | less -R"
  4. git config --global interactive.difffilter diffr

In case there are issues with less: winget install jftuga.less

Rainproof answered 10/10, 2023 at 21:45 Comment(1)
Cool, but it still requires two files. OP was asking about highlighting for a single patch file, not two individual files with differences. See the OP and accepted answer. I also concede this question has become a search result for visualizing differences between multiple files, regardless of my original question.Ministration

© 2022 - 2024 — McMap. All rights reserved.