git-gutter.el is port of GitGutter
which is a plugin of Sublime Text. git-gutter.el supports git and mercurial.
git-gutter.el also supports TRAMP so you can use git-gutter.el for remote files.
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 | OK(experimental) | 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 +1)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)
Set start revision where got diff(git diff or hg diff) from.
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.
Stage current hunk. You can use this command like git add -p.
This command is not supported for Mercurial.
Revert current hunk
Show changes from last commit or Update change information. Please execute this command if diff information is not be updated.
Clear changes
Toggle git-gutter
Setup for working with linum-mode.
Update git-gutter information of buffers in all visible window.
(require 'git-gutter)
;; If you enable global minor mode
(global-git-gutter-mode t)
;; If you would like to use git-gutter.el and linum-mode
(git-gutter:linum-setup)
;; 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)
;; Stage current hunk
(global-set-key (kbd "C-x v s") 'git-gutter:stage-hunk)
;; Revert current hunk
(global-set-key (kbd "C-x v r") 'git-gutter:revert-hunk)
You can change the signs and those faces.
(custom-set-variables
'(git-gutter:modified-sign " ") ;; two space
'(git-gutter:added-sign "++") ;; multiple character is OK
'(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
(custom-set-variables
'(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.
(custom-set-variables
'(git-gutter:window-width 2)
'(git-gutter:modified-sign "☁")
'(git-gutter:added-sign "☀")
'(git-gutter:deleted-sign "☂"))git-gutter.el supports git and mercurial backends.
You can set backends which git-gutter.el will be used.
Default value of git-gutter:handled-backends is '(git hg)
;; If you can use git-gutter only for git
(custom-set-variables
'(git-gutter:handled-backends '(git)))diff information is updated at hooks in git-gutter:update-hooks.
(add-to-list 'git-gutter:update-hooks 'focus-in-hook)diff information is updated after command in git-gutter:update-commands executed.
(add-to-list 'git-gutter:update-commands 'other-window)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
(custom-set-variables
'(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.
(custom-set-variables
'(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.
(custom-set-variables
'(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)
(custom-set-variables
'(git-gutter:hide-gutter t))You can pass git diff option to set git-gutter:diff-option.
;; ignore all spaces
(custom-set-variables
'(git-gutter:diff-option "-w"));; Don't need log/message.
(custom-set-variables
'(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.