git-gutter.el
is port of GitGutter
which is a plugin of Sublime Text.
git-gutter.el
also supports TRAMP so you can use git-gutter.el
for remote files.
- Emacs 23 or higher
- Git 1.7.0 or higher
git-gutter.el vs git-gutter-fringe.el
git-gutter.el | git-gutter-fringe.el | |
---|---|---|
Work in tty frame | OK | NG |
Work with linum-mode | NG | OK |
Show on right side | NG | OK |
More configurable | OK | NG |
You can install git-gutter.el
from MELPA with package.el
(M-x package-install git-gutter
).
And you can also install it with el-get.
git-gutter.el
provides global minor-mode(global-git-gutter-mode
) and minor-mode(git-gutter-mode
).
If you want to use git-gutter
for files in git repository.
You add following s-exp in your configuration file(~/.emacs.d/init.el
or ~/.emacs
).
(global-git-gutter-mode t)
Other case, you want to use git-gutter
for some files, you can use git-gutter-mode
.
Following example of enabling git-gutter
for some mode.
(add-hook 'ruby-mode-hook 'git-gutter-mode)
(add-hook 'python-mode-hook 'git-gutter-mode)
git-gutter.el
provides following commands.
Jump to next hunk(alias git-gutter:next-diff
)
Jump to previous hunk(alias git-gutter:previous-diff
)
Popup current diff hunk(alias git-gutter:popup-diff
)
git-gutter:next-hunk
and git-gutter:previous-hunk
update content
of buffer popuped by git-gutter:popup-diff
to current hunk.
Revert current hunk
Show changes from last commit or Update change information.
Clear changes
Toggle git-gutter
(require 'git-gutter)
;; If you enable global minor mode
(global-git-gutter-mode t)
;; If you enable git-gutter-mode for some modes
(add-hook 'ruby-mode-hook 'git-gutter-mode)
(global-set-key (kbd "C-x C-g") 'git-gutter:toggle)
(global-set-key (kbd "C-x v =") 'git-gutter:popup-hunk)
;; Jump to next/previous hunk
(global-set-key (kbd "C-x p") 'git-gutter:previous-hunk)
(global-set-key (kbd "C-x n") 'git-gutter:next-hunk)
;; Revert current hunk
(global-set-key (kbd "C-x r") 'git-gutter:revert-hunk)
You can change the signs and those faces.
(setq git-gutter:modified-sign " ") ;; two space
(setq git-gutter:added-sign "++") ;; multiple character is OK
(setq git-gutter:deleted-sign "--")
(set-face-background 'git-gutter:modified "purple") ;; background color
(set-face-foreground 'git-gutter:added "green")
(set-face-foreground 'git-gutter:deleted "red")
You can change minor-mode name in mode-line to set git-gutter:lighter
.
Default is " GitGutter"
;; first character should be a space
(setq git-gutter:lighter " GG")
Emacs has char-width
function which returns character width.
git-gutter.el
uses it for calculating character length of the signs.
But char-width
does not work for some full-width characters.
So you should explicitly specify window width, if you use full-width
character.
(setq git-gutter:window-width 2)
(setq git-gutter:modified-sign "☁")
(setq git-gutter:added-sign "☀")
(setq git-gutter:deleted-sign "☂")
git-gutter.el
with GUI Emacs on MacOSX makes display strange.
This issues is only GUI mode.(If you have use CUI mode(emacs -nw
),
it may be no problems)
You can avoid this issue by adding additional space to each diff signs like below.
(setq git-gutter:added-sign "+ ")
(setq git-gutter:deleted-sign "- ")
(setq git-gutter:modified-sign "= ")
git-gutter.el
updates gutter at hooks below
after-save-hook
after-revert-hook
window-configuration-change-hook
window-configuration-change-hook
is run at buffer updated, window construction
changed etc. But it's hook is called a lot of times and it makes Emacs slow.
Additionally it is difficult to control(Update function is called (2 * N)
times if you show N windows in frame).
So git-gutter.el
does not call update function within git-gutter:update-threshold
second(Default is 1 second) at window-configuration-change-hook
. Please set longer
time if you feel slow yet. Update function is always called if git-gutter:update-threshold
is nil.
If you even feel Emacs slow, please remove window-configuration-change-hook
to
update points as below and instead you update M-x git-gutter
manually when needed.
(setq git-gutter:update-threshold 2)
(setq git-gutter:update-hooks '(after-save-hook after-revert-hook))
You can also add other hook points by setting git-gutter:update-hooks
.
If you use global-git-gutter-mode
, you may want some modes to disable
git-gutter-mode
. You can make it by setting git-gutter:disabled-modes
to non-nil
.
;; inactivate git-gutter-mode in asm-mode and image-mode
(setq git-gutter:disabled-modes '(asm-mode image-mode))
Default is nil
.
git-gutter.el
can view unchanged information by setting git-gutter:unchanged-sign
.
Like following.
(setq git-gutter:unchanged-sign " ")
(set-face-background 'git-gutter:unchanged "yellow")
Default value of git-gutter:unchanged-sign
is nil
.
git-gutter.el
can display an additional separator character at the right of the changed
signs. This is mostly useful when running emacs in a console.
(setq git-gutter:separator-sign "|")
(set-face-foreground 'git-gutter:separator "yellow")
Default value of git-gutter:separator-sign
is nil
.
Hide gutter when there are no changes if git-gutter:hide-gutter
is non-nil.
(Default is nil)
(setq git-gutter:hide-gutter t)
You can pass git diff
option to set git-gutter:diff-option
.
;; ignore all spaces
(setq git-gutter:diff-option "-w")
;; Don't need log/message.
(setq git-gutter:verbosity 0)
Default value is 4(0
is lowest, 4
is highest).
Run hook git-gutter-mode-on-hook
when git-gutter-mode
is turn on, and
run hook git-gutter-mode-off-hook
when git-gutter-mode
is turn off.
GitGutter is Sublime Text plugin.
Vim version of GitGutter
diff-hl
has more features than git-gutter.el
.
Fork of git-gutter.el
.