Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Emacs package for highlighting uncommitted changes
Emacs Lisp
Branch: master

README.md

About

diff-hl-mode highlights uncommitted changes on the left side of the window, allows you to jump between and revert them selectively.

For the usage instructions and the list of commands, see the Commentary section inside the file.

Tested with Git, Mercurial, Bazaar and SVN. May work with other VC backends, too.

The package also contains auxiliary modes:

  • diff-hl-dired-mode provides similar functionality in Dired.
  • diff-hl-margin-mode changes the highlighting function to use the margin instead of the fringe.
  • diff-hl-amend-mode shifts the reference revision back by one.

Check out the Commentary section in each respective file for the usage instructions.

Screenshots

diff-hl-mode

Top window: a buffer in this minor mode, bottom window: the corresponding diff.

screenie

diff-hl-dired-mode

screenie

diff-hl-margin-mode

screenie

Requirements

Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.

Notes

  • Since it uses the corresponding VC diff command, it's only accurate when the buffer is in saved state. Highlighting changes "on the fly" might be better, maybe we can do something similar to highlight-markup-buffers with a hidden buffer containing the unmodified copy.

  • We conflict with other modes when they put indicators on the fringe, such as Flycheck. This is rarely a significant problem, since if you're using such a mode, you'd usually want to fix all errors and warnings before continuing, and then the conflicting indicators go away.

  • There's no fringe when Emacs is running in the console, but the navigation and revert commands still work. Consider turning diff-hl-margin-mode on, to show the indicators in the margin instead.

  • Frame-local and buffer-local values of line-spacing are not supported.

  • emacs-git-gutter shows indicators in the margin by default, allows you to customize how the indicators look more easily, and has a "stage hunk" command.

Integration

If you're using some package other than vc to commit changes, it might not run vc-checkin-hook after commits. In that case, you'll need to either add diff-hl-update to the hook it does run, or advise some function that's called in the buffer after its state has changed.

psvn

(defadvice svn-status-update-modeline (after svn-update-diff-hl activate)
  (diff-hl-update))

Magit

If you have a recent enough version installed, it defines magit-revert-buffer-hook (or magit-not-reverted-hook), which we use.

Something went wrong with that request. Please try again.