This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+source-control/git/packages.el

416 lines
16 KiB
EmacsLisp
Raw Normal View History

;;; packages.el --- Git Layer packages File for Spacemacs
;;
2018-01-04 07:00:25 +00:00
;; Copyright (c) 2012-2018 Sylvain Benner & Contributors
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;;; License: GPLv3
(setq git-packages
'(
2015-11-06 23:24:51 +00:00
evil-magit
fill-column-indicator
gitattributes-mode
gitconfig-mode
gitignore-mode
git-commit
git-link
git-messenger
git-timemachine
2017-07-03 07:52:54 +00:00
(helm-gitignore :requires helm)
magit
2015-07-25 14:44:18 +00:00
magit-gitflow
;; not compatible with magit 2.1 at the time of release
;; magit-svn
2017-07-03 07:52:54 +00:00
(orgit :requires org)
smeargle
))
(defun git/init-evil-magit ()
Use evil in holy-mode Motivation While disabling Evil in holy-mode makes its implementation shorter and sounds elegant on the paper, in practice it puts a big burden on the configuration parts which need to know if Evil is enable or not. This is a bad separation of concerns and the bunch of fixes that we were forced to do in the past weeks shows this issue. Those fixes were about removing the knowledge of the activation of Evil by implementing new dispatching functions to be used by layers, this is cumbersome and makes Spacemacs layer configuration more subtle which is not good. There was additional bad consequences of the removal of Evil state like the impossibility to use Evil lisp state or iedit states, or we would have been forced to implement a temporary activation of Evil which is awkward. Instead I reintroduce Evil as the central piece of Spacemacs design thus Evil is now re-enabled in holy-mode. It provides the abstraction we need to isolate editing styles and be able to grow the Spacemacs configuration coverage sanely. Layers don't need to check whether the holy mode is active or not and they don't need to know if Evil is available (it is always available). We also don't need to write additional dispatching functions, this is the job of Evil, and I think it provides everything for this. Ideally configuration layer should be implemented with only Evil in mind and the holy-mode (and hybrid-mode) should magically make it work for Emacs style users, for instance we can freely use `evil-insert-state` anywhere in the code without any guard. Evil is now even more part of Spacemacs, we can really say that Spacemacs is Emacs+Evil which is now an indivisible pair. Spacemacs needed this stable API to continue on the right track. While these changes should be rather transparent to the user, I'm sorry for this experimental period, I failed to see all the implications of such a change, I was just excited about the possibility to make Evil optional. The reality is that Spacemacs has to embrace it and keep its strong position on being Emacs+Evil at the core. Implementation - insert, motion and normal states are forced to emacs state using an advice on `evil-insert-state`, `evil-motion-state` and `evil-normal-state` respectively. These functions can be used freely in the layer configuration. - A new general hook `spacemacs-editing-style-hook` allow to hook any code that need to be configured based on the editing style. Functions hooked to this hook takes the current style as parameter, this basically generalize the hook used to setup hjkl navigation bindings. - ESC has been removed from the emacs state map. - Revert unneeded changes - Revert "evil: enter insert-state only from normal-state" commit bdd702dfbe302206bbc989c7a0832daba087a781. - Revert "avoid being evil in deft with emacs editing style" commit f3a16f49ed27cc8cf05f23f93b006d6e04235381. Additional changes All editing style packages have been moved to a layer called `spacemacs-editing-styles` Notes I did not have time to attack hybrid mode, I should be able to do it later.
2016-03-13 23:41:18 +00:00
(with-eval-after-load 'magit
(require 'evil-magit)
(evil-define-key 'motion magit-mode-map
(kbd dotspacemacs-leader-key) spacemacs-default-map)))
(defun git/post-init-fill-column-indicator ()
(add-hook 'git-commit-mode-hook 'fci-mode))
(defun git/init-helm-gitignore ()
(use-package helm-gitignore
:defer t
:init (spacemacs/set-leader-keys "gI" 'helm-gitignore)))
2015-05-18 02:43:42 +00:00
(defun git/init-git-commit ()
2015-07-26 05:03:30 +00:00
(use-package git-commit
:defer t))
(defun git/init-git-link ()
(use-package git-link
:defer t
:init
(progn
2016-07-05 03:17:14 +00:00
(spacemacs/declare-prefix "gl" "links")
(spacemacs/set-leader-keys
"gll" 'spacemacs/git-link
"glL" 'spacemacs/git-link-copy-url-only
"glc" 'spacemacs/git-link-commit
"glC" 'spacemacs/git-link-commit-copy-url-only)
;; default is to open the generated link
(setq git-link-open-in-browser t))))
2014-12-14 04:59:02 +00:00
(defun git/init-git-messenger ()
(use-package git-messenger
:defer t
:init (spacemacs/set-leader-keys "gM" 'git-messenger:popup-message)
:config (define-key git-messenger-map [escape] 'git-messenger:popup-close)))
2014-12-14 04:59:02 +00:00
(defun git/init-git-timemachine ()
(use-package git-timemachine
:defer t
2016-01-20 02:55:38 +00:00
:commands spacemacs/time-machine-transient-state/body
2014-12-14 04:59:02 +00:00
:init
(spacemacs/set-leader-keys
2016-01-20 02:55:38 +00:00
"gt" 'spacemacs/time-machine-transient-state/body)
:config
(progn
2016-01-20 02:55:38 +00:00
(spacemacs|define-transient-state time-machine
:title "Git Timemachine Transient State"
:doc "
[_p_/_N_] previous [_n_] next [_c_] current [_g_] goto nth rev [_Y_] copy hash [_q_] quit"
:on-enter (let (golden-ratio-mode)
(unless (bound-and-true-p git-timemachine-mode)
(call-interactively 'git-timemachine)))
:on-exit (when (bound-and-true-p git-timemachine-mode)
(git-timemachine-quit))
:foreign-keys run
:bindings
("c" git-timemachine-show-current-revision)
("g" git-timemachine-show-nth-revision)
("p" git-timemachine-show-previous-revision)
("n" git-timemachine-show-next-revision)
("N" git-timemachine-show-previous-revision)
("Y" git-timemachine-kill-revision)
("q" nil :exit t)))))
2014-12-14 04:59:02 +00:00
2015-03-26 16:10:54 +00:00
(defun git/init-gitattributes-mode ()
(use-package gitattributes-mode
:defer t))
(defun git/init-gitconfig-mode ()
(use-package gitconfig-mode
:defer t))
2015-03-26 16:10:54 +00:00
(defun git/init-gitignore-mode ()
(use-package gitignore-mode
:defer t))
2014-12-14 04:59:02 +00:00
(defun git/init-magit ()
(use-package magit
:defer t
2014-12-14 04:59:02 +00:00
:init
(progn
(setq magit-completing-read-function
(if (configuration-layer/layer-used-p 'ivy)
'ivy-completing-read
'magit-builtin-completing-read))
(setq magit-revision-show-gravatars '("^Author: " . "^Commit: "))
;; On Windows, we must use Git GUI to enter username and password
;; See: https://github.com/magit/magit/wiki/FAQ#windows-cannot-push-via-https
(when (eq window-system 'w32)
(setenv "GIT_ASKPASS" "git-gui--askpass"))
;; key bindings
2015-11-28 00:23:42 +00:00
(spacemacs/declare-prefix "gd" "diff")
(spacemacs/declare-prefix "gf" "file")
(spacemacs/set-leader-keys
"gb" 'spacemacs/git-blame-micro-state
"gc" 'magit-clone
"gff" 'magit-find-file
"gfh" 'magit-log-buffer-file
"gi" 'magit-init
2016-09-12 14:54:26 +00:00
"gL" 'magit-list-repositories
"gm" 'magit-dispatch-popup
"gs" 'magit-status
"gS" 'magit-stage-file
"gU" 'magit-unstage-file)
;; transient state
;; TODO use transient state instead of old micro-state, IIRC we continue
;; to use micro-state because of the re-entry keyword :on-enter which is
;; not available in transient state
(spacemacs|define-micro-state git-blame
2016-01-20 02:55:38 +00:00
:title "Git Blame Transient State"
2016-01-21 21:06:15 +00:00
:doc "
Press [_b_] again to blame further in the history, [_q_] to go up or quit."
:on-enter (let (golden-ratio-mode)
(unless (bound-and-true-p magit-blame-mode)
(call-interactively 'magit-blame)))
:foreign-keys run
2015-10-19 03:36:03 +00:00
:bindings
("b" magit-blame)
;; here we use the :exit keyword because we should exit the
;; micro-state only if the magit-blame-quit effectively disable
;; the magit-blame mode.
("q" nil :exit (progn (when (bound-and-true-p magit-blame-mode)
(magit-blame-quit))
(not (bound-and-true-p magit-blame-mode))))))
2014-12-14 04:59:02 +00:00
:config
(progn
;; seems to be necessary at the time of release
(require 'git-rebase)
;; bind function keys
;; (define-key magit-mode-map (kbd "<tab>") 'magit-section-toggle)
2016-09-12 14:54:26 +00:00
(evilified-state-evilify-map magit-repolist-mode-map
:mode magit-repolist-mode
:bindings
(kbd "gr") 'magit-list-repositories
(kbd "RET") 'magit-repolist-status)
(unless (configuration-layer/package-used-p 'evil-magit)
;; use auto evilification if `evil-magit' is not used
(evilified-state-evilify-map magit-mode-map
:bindings
"gr" 'magit-refresh
"gR" 'magit-refresh-all)
(evilified-state-evilify-map magit-status-mode-map
:mode magit-status-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-refs-mode-map
:mode magit-refs-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-blame-mode-map
:mode magit-blame-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-hunk-section-map
:mode magit-status-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-diff-mode-map
:mode magit-diff-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-log-read-revs-map
:mode magit-log-read-revs
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-log-mode-map
:mode magit-log-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-log-select-mode-map
:mode magit-log-select-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-cherry-mode-map
:mode magit-cherry-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-reflog-mode-map
:mode magit-reflog-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-process-mode-map
:mode magit-process-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map magit-stash-mode-map
:mode magit-stash-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward)
(evilified-state-evilify-map git-rebase-mode-map
:mode git-rebase-mode
:bindings
(kbd "C-S-j") 'magit-section-forward
(kbd "C-S-k") 'magit-section-backward
(kbd "C-n") 'magit-section-forward
(kbd "C-p") 'magit-section-backward
"J" 'git-rebase-move-line-down
"K" 'git-rebase-move-line-up
"u" 'git-rebase-undo
"y" 'git-rebase-insert)
;; default state for additional modes
(dolist (mode '(magit-popup-mode
magit-popup-sequence-mode))
(evil-set-initial-state mode 'emacs))
(let ((refresh-key "gr")
(refresh-all-key "gR")
(delete-key (nth 0 (where-is-internal 'magit-delete-thing
magit-mode-map))))
(evilified-state--configure-default-state 'magit-revision-mode)
;; section maps
(eval `(evilified-state-evilify-map magit-tag-section-map
:pre-bindings
,delete-key 'magit-tag-delete
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-untracked-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-branch-section-map
:pre-bindings
,delete-key 'magit-branch-delete
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-remote-section-map
:pre-bindings
,delete-key 'magit-remote-remove
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-file-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-hunk-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-unstaged-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-staged-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-commit-section-map
:pre-bindings
,delete-key 'magit-discard
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-stashes-section-map
:pre-bindings
,delete-key 'magit-stash-clear
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-stash-section-map
:pre-bindings
,delete-key 'magit-stash-drop
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-module-commit-section-map
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-unpulled-section-map
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))
(eval `(evilified-state-evilify-map magit-unpushed-section-map
:bindings
,refresh-key 'magit-refresh
,refresh-all-key 'magit-refresh-all))))
;; confirm/abort
(when dotspacemacs-major-mode-leader-key
(add-hook 'with-editor-mode-hook 'evil-normalize-keymaps)
(let ((mm-key dotspacemacs-major-mode-leader-key))
(dolist (state '(normal motion))
(evil-define-key state with-editor-mode-map
(concat mm-key mm-key) 'with-editor-finish
(concat mm-key "a") 'with-editor-cancel
(concat mm-key "c") 'with-editor-finish
(concat mm-key "k") 'with-editor-cancel))))
;; whitespace
(define-key magit-status-mode-map (kbd "C-S-w")
'spacemacs/magit-toggle-whitespace)
;; full screen magit-status
(when git-magit-status-fullscreen
(setq magit-display-buffer-function 'magit-display-buffer-fullframe-status-v1)))))
2014-12-14 04:59:02 +00:00
(defun git/init-magit-gitflow ()
(use-package magit-gitflow
:commands turn-on-magit-gitflow
:init (progn
(add-hook 'magit-mode-hook 'turn-on-magit-gitflow)
(with-eval-after-load 'magit
(define-key magit-mode-map "%" 'magit-gitflow-popup)))
2014-12-14 04:59:02 +00:00
:config (spacemacs|diminish magit-gitflow-mode "Flow")))
2015-01-27 05:17:51 +00:00
(defun git/init-magit-svn ()
(use-package magit-svn
:if git-enable-magit-svn-plugin
2015-01-27 05:17:51 +00:00
:commands turn-on-magit-svn
:init (add-hook 'magit-mode-hook 'turn-on-magit-svn)
:config
(progn
(evil-define-key 'emacs magit-status-mode-map
"N" 'magit-key-mode-popup-svn))))
(defun git/init-orgit ())
2014-12-14 04:59:02 +00:00
(defun git/init-smeargle ()
(use-package smeargle
:defer t
:init
(progn
(spacemacs/declare-prefix "gH" "highlight")
(when (configuration-layer/package-used-p 'which-key)
;; TODO abstract this to a function
(let ((descr
'(("smeargle" . "highlight by last update time")
("smeargle-commits" . "highlight by age of changes")
("smeargle-clear" . "clear"))))
(dolist (nd descr)
;; ensure the target matches the whole string
(push (cons (cons nil (concat "\\`" (car nd) "\\'")) (cons nil (cdr nd)))
which-key-replacement-alist))))
(spacemacs/set-leader-keys
"gHc" 'smeargle-clear
"gHh" 'smeargle-commits
"gHt" 'smeargle))))