emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/vc-gutter/config.el

221 lines
9.9 KiB
EmacsLisp
Raw Normal View History

feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
;;; ui/vc-gutter/config.el -*- lexical-binding: t; -*-
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
;; TODO Implement me
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
(defvar +vc-gutter-in-margin nil
"If non-nil, use the margin for diffs instead of the fringe.")
(defvar +vc-gutter-in-remote-files nil
"If non-nil, enable the vc gutter in remote files (e.g. open through TRAMP).")
refactor!(vc-gutter): move style defaults behind +pretty BREAKING CHANGE: This changes moves its default configuration of the fringe behind a +pretty flag. This won't cause breakage, but will cause a (possibly unwanted) visual change: git-gutter will use its default indicators (e.g. + and - symbols) instead of the continuous bars from before. To get back the old look, enable `+pretty` on the `:ui vc-gutter` module. This was done to make the defaults toggleable, to standardize +pretty, to document issues with this customization that have been brought up by members of the Emacs community, and to better document it in comments for posterity.
2022-08-08 17:36:23 +02:00
;;
;;; Default styles
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(when (modulep! +pretty)
refactor!(vc-gutter): move style defaults behind +pretty BREAKING CHANGE: This changes moves its default configuration of the fringe behind a +pretty flag. This won't cause breakage, but will cause a (possibly unwanted) visual change: git-gutter will use its default indicators (e.g. + and - symbols) instead of the continuous bars from before. To get back the old look, enable `+pretty` on the `:ui vc-gutter` module. This was done to make the defaults toggleable, to standardize +pretty, to document issues with this customization that have been brought up by members of the Emacs community, and to better document it in comments for posterity.
2022-08-08 17:36:23 +02:00
;; UI: make the fringe small enough that the diff bars aren't too domineering,
;; while leaving enough room for other indicators.
(if (fboundp 'fringe-mode) (fringe-mode '8))
;; UI: the gutter looks less cramped with some space between it and buffer.
(setq-default fringes-outside-margins t)
;; STYLE: Redefine fringe bitmaps to take up only half the horizontal space in
;; the fringe. This way we avoid overbearingly large diff bars without having
;; to shrink the fringe and sacrifice precious space for other fringe
;; indicators (like flycheck or flyspell).
;; TODO Extract these into a package with faces that themes can target.
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(if (not (modulep! +diff-hl))
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
(after! git-gutter-fringe
(define-fringe-bitmap 'git-gutter-fr:added [224]
nil nil '(center repeated))
(define-fringe-bitmap 'git-gutter-fr:modified [224]
nil nil '(center repeated))
(define-fringe-bitmap 'git-gutter-fr:deleted [128 192 224 240]
nil nil 'bottom))
(defadvice! +vc-gutter-define-thin-bitmaps-a (&rest args)
:override #'diff-hl-define-bitmaps
(define-fringe-bitmap 'diff-hl-bmp-middle [224] nil nil '(center repeated))
(define-fringe-bitmap 'diff-hl-bmp-delete [240 224 192 128] nil nil 'top))
(defun +vc-gutter-type-face-fn (type _pos)
(intern (format "diff-hl-%s" type)))
(defun +vc-gutter-type-at-pos-fn (type _pos)
(if (eq type 'delete)
'diff-hl-bmp-delete
'diff-hl-bmp-middle))
fix(vc-gutter): apply +pretty to diff-hl-dired-mode Amend: cd9bc5a1fdaa
2022-08-09 14:58:12 +02:00
(advice-add #'diff-hl-fringe-bmp-from-pos :override #'+vc-gutter-type-at-pos-fn)
(advice-add #'diff-hl-fringe-bmp-from-type :override #'+vc-gutter-type-at-pos-fn)
(setq diff-hl-draw-borders nil)
(add-hook! 'diff-hl-mode-hook
(defun +vc-gutter-fix-diff-hl-faces-h ()
(mapc (doom-rpartial #'set-face-background nil)
'(diff-hl-insert
diff-hl-delete
diff-hl-change)))))
refactor!(vc-gutter): move style defaults behind +pretty BREAKING CHANGE: This changes moves its default configuration of the fringe behind a +pretty flag. This won't cause breakage, but will cause a (possibly unwanted) visual change: git-gutter will use its default indicators (e.g. + and - symbols) instead of the continuous bars from before. To get back the old look, enable `+pretty` on the `:ui vc-gutter` module. This was done to make the defaults toggleable, to standardize +pretty, to document issues with this customization that have been brought up by members of the Emacs community, and to better document it in comments for posterity.
2022-08-08 17:36:23 +02:00
;; FIX: To minimize overlap between flycheck indicators and git-gutter/diff-hl
;; indicators in the left fringe.
(after! flycheck
;; let diff have left fringe, flycheck can have right fringe
(setq flycheck-indication-mode 'right-fringe)
;; A non-descript, left-pointing arrow
(define-fringe-bitmap 'flycheck-fringe-bitmap-double-arrow
[16 48 112 240 112 48 16] nil nil 'center)))
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
;;
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
;;; git-gutter
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! git-gutter
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
:unless (modulep! +diff-hl)
Minor reformatting across the board Gotta Look Nice
2019-07-22 19:11:12 +02:00
:commands git-gutter:revert-hunk git-gutter:stage-hunk
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
:init
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! 'find-file-hook
:boom: revise hook/var fns naming convention (2/2) This is second of three big naming convention changes. In this commit, we change the naming conventions for hook functions and variable functions: 1. Replace the bar | to indicate a hook function with a -h suffix, e.g. doom|init-ui -> doom-init-ui-h doom|run-local-var-hooks -> doom-run-local-var-hooks-h 2. And add a -fn suffix for functions meant to be set on variables, e.g. (setq magit-display-buffer-function #'+magit-display-buffer-fn) See ccf327f8 for the reasoning behind these changes.
2019-07-18 15:27:20 +02:00
(defun +vc-gutter-init-maybe-h ()
"Enable `git-gutter-mode' in the current buffer.
ui/vc-gutter: defer git-gutter until file exists If the current buffer doesn't represent a real file, defer enabling git-gutter-mode until the file is saved.
2019-05-06 02:14:14 -04:00
If the buffer doesn't represent an existing file, `git-gutter-mode's activation
Minor, general refactor & comment revision
2019-06-14 11:08:59 +02:00
is deferred until the file is saved. Respects `git-gutter:disabled-modes'."
Fix git-gutter in indirect buffers
2020-02-25 12:49:52 -05:00
(let ((file-name (buffer-file-name (buffer-base-buffer))))
Refactor +vc-gutter-init-maybe-h Also addresses a few edge cases where git-gutter-mode wasn't later activated in file-less buffers that are later saved to files.
2021-02-26 21:25:16 -05:00
(cond
((and (file-remote-p (or file-name default-directory))
(not +vc-gutter-in-remote-files)))
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; UX: If not a valid file, wait until it is written/saved to activate
Refactor +vc-gutter-init-maybe-h Also addresses a few edge cases where git-gutter-mode wasn't later activated in file-less buffers that are later saved to files.
2021-02-26 21:25:16 -05:00
;; git-gutter.
((not (and file-name (vc-backend file-name)))
(add-hook 'after-save-hook #'+vc-gutter-init-maybe-h nil 'local))
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; UX: Allow git-gutter or git-gutter-fringe to activate based on the
;; type of frame we're in. This allows git-gutter to work for silly
;; geese who open both tty and gui frames from the daemon.
Refactor +vc-gutter-init-maybe-h Also addresses a few edge cases where git-gutter-mode wasn't later activated in file-less buffers that are later saved to files.
2021-02-26 21:25:16 -05:00
((if (and (display-graphic-p)
(require 'git-gutter-fringe nil t))
(setq-local git-gutter:init-function #'git-gutter-fr:init
git-gutter:view-diff-function #'git-gutter-fr:view-diff-infos
git-gutter:clear-function #'git-gutter-fr:clear
git-gutter:window-width -1)
(setq-local git-gutter:init-function 'nil
git-gutter:view-diff-function #'git-gutter:view-diff-infos
git-gutter:clear-function #'git-gutter:clear-diff-infos
git-gutter:window-width 1))
Fix #4815: respect git-gutter:disabled-modes
2021-03-18 01:05:39 -04:00
(unless (memq major-mode git-gutter:disabled-modes)
(git-gutter-mode +1)
(remove-hook 'after-save-hook #'+vc-gutter-init-maybe-h 'local)))))))
:boom: revise hook/var fns naming convention (2/2) This is second of three big naming convention changes. In this commit, we change the naming conventions for hook functions and variable functions: 1. Replace the bar | to indicate a hook function with a -h suffix, e.g. doom|init-ui -> doom-init-ui-h doom|run-local-var-hooks -> doom-run-local-var-hooks-h 2. And add a -fn suffix for functions meant to be set on variables, e.g. (setq magit-display-buffer-function #'+magit-display-buffer-fn) See ccf327f8 for the reasoning behind these changes.
2019-07-18 15:27:20 +02:00
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; UX: Disable in Org mode, as per syl20bnr/spacemacs#10555 and
Minor refactors
2020-04-16 21:55:59 -04:00
;; syohex/emacs-git-gutter#24. Apparently, the mode-enabling function for
;; global minor modes gets called for new buffers while they are still in
;; `fundamental-mode', before a major mode has been assigned. I don't know why
;; this is the case, but adding `fundamental-mode' here fixes the issue.
Enable git-gutter on find-file-hook and org-mode And disable it in pdf-view-mode. Perhaps this is too comprehensive?
2019-07-23 20:43:35 +02:00
(setq git-gutter:disabled-modes '(fundamental-mode image-mode pdf-view-mode))
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
:config
Minor refactors
2020-04-16 21:55:59 -04:00
(set-popup-rule! "^\\*git-gutter" :select nil :size '+popup-shrink-to-fit)
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; PERF: Only enable the backends that are available, so it doesn't have to
;; check when opening each buffer.
Minor refactors
2020-04-16 21:55:59 -04:00
(setq git-gutter:handled-backends
(cons 'git (cl-remove-if-not #'executable-find (list 'hg 'svn 'bzr)
:key #'symbol-name)))
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; UX: update git-gutter on focus (in case I was using git externally)
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
(add-hook 'focus-in-hook #'git-gutter:update-all-windows)
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! '(doom-escape-hook doom-switch-window-hook) :append
:boom: revise hook/var fns naming convention (2/2) This is second of three big naming convention changes. In this commit, we change the naming conventions for hook functions and variable functions: 1. Replace the bar | to indicate a hook function with a -h suffix, e.g. doom|init-ui -> doom-init-ui-h doom|run-local-var-hooks -> doom-run-local-var-hooks-h 2. And add a -fn suffix for functions meant to be set on variables, e.g. (setq magit-display-buffer-function #'+magit-display-buffer-fn) See ccf327f8 for the reasoning behind these changes.
2019-07-18 15:27:20 +02:00
(defun +vc-gutter-update-h (&rest _)
"Refresh git-gutter on ESC. Return nil to prevent shadowing other
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
`doom-escape-hook' hooks."
ui/vc-gutter: minor refactor
2021-03-05 20:07:26 -05:00
(ignore (or (memq this-command '(git-gutter:stage-hunk
Refactor +vc-gutter-init-maybe-h Also addresses a few edge cases where git-gutter-mode wasn't later activated in file-less buffers that are later saved to files.
2021-02-26 21:25:16 -05:00
git-gutter:revert-hunk))
ui/vc-gutter: minor refactor
2021-03-05 20:07:26 -05:00
inhibit-redisplay
(if git-gutter-mode
(git-gutter)
(+vc-gutter-init-maybe-h))))))
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
;; UX: update git-gutter when using magit commands
:boom: revise hook/var fns naming convention (2/2) This is second of three big naming convention changes. In this commit, we change the naming conventions for hook functions and variable functions: 1. Replace the bar | to indicate a hook function with a -h suffix, e.g. doom|init-ui -> doom-init-ui-h doom|run-local-var-hooks -> doom-run-local-var-hooks-h 2. And add a -fn suffix for functions meant to be set on variables, e.g. (setq magit-display-buffer-function #'+magit-display-buffer-fn) See ccf327f8 for the reasoning behind these changes.
2019-07-18 15:27:20 +02:00
(advice-add #'magit-stage-file :after #'+vc-gutter-update-h)
ui/vc-gutter: fix {next,previous}-hunk commands They would sometimes jump to random hunks.
2019-09-27 15:15:30 -04:00
(advice-add #'magit-unstage-file :after #'+vc-gutter-update-h)
(defadvice! +vc-gutter--fix-linearity-of-hunks-a (diffinfos is-reverse)
nit(vc-gutter): add summary tags to comments A new convention I'm slowly rolling out to modules to help readers quickly identify the purpose of a change. E.g. UX - a change done to improve user experience STYLE - for aesthetics FIX - addresses a perceived or potential issue PERF - intended to improve performance Combined tags will be delimited with commas. E.g. "UX,PERF:" There may be more later, and these will be further documented in the new docs about to come up.
2022-08-10 14:06:52 +02:00
"FIX: `git-gutter:next-hunk' and `git-gutter:previous-hunk' sometimes
ui/vc-gutter: fix {next,previous}-hunk commands They would sometimes jump to random hunks.
2019-09-27 15:15:30 -04:00
jumping to random hunks."
:override #'git-gutter:search-near-diff-index
ui/vc-gutter: minor refactor
2021-03-05 20:07:26 -05:00
(cl-position-if (let ((lineno (line-number-at-pos))
(fn (if is-reverse #'> #'<)))
(lambda (line) (funcall fn lineno line)))
ui/vc-gutter: fix {next,previous}-hunk commands They would sometimes jump to random hunks.
2019-09-27 15:15:30 -04:00
diffinfos
:key #'git-gutter-hunk-start-line
:from-end is-reverse)))
feature/version-control => ui/vc-gutter, emacs/vc Reorganize vcs functionality. Moves the custom fringe bitmaps into :ui vc-gutter.
2018-06-21 21:14:00 +02:00
ui/vc-gutter: fix git-gutter in tty Emacs Use git-gutter-mode in tty Emacs, and git-gutter-fringe in GUI Emacs.
2018-10-03 19:01:06 -04:00
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
;;
;;; diff-hl
(use-package! diff-hl
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
:when (modulep! +diff-hl)
refactor(vc-gutter): use local modes instead of global
2022-08-09 14:57:00 +02:00
:hook (find-file . diff-hl-mode)
:hook (vc-dir-mode . diff-hl-dir-mode)
refactor!(dired): move diff-hl config to :ui vc-gutter BREAKING CHANGE: users who are used to diff-hl displaying diffs in dired will notice they have vanished. diff-hl's conig has been moved to :ui vc-gutter +diff-hl (added in 27a448b). Enable it to get it back. Ref: 27a448b04b81
2022-08-09 14:59:17 +02:00
:hook (dired-mode . diff-hl-dired-mode)
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
:hook (diff-hl-mode . diff-hl-flydiff-mode)
:config
(set-popup-rule! "^\\*diff-hl" :select nil :size '+popup-shrink-to-fit)
;; PERF: reduce load on remote
(defvaralias 'diff-hl-disable-on-remote '+vc-gutter-in-remote-files)
;; PERF: A slightly faster algorithm for diffing.
(setq vc-git-diff-switches '("--histogram"))
;; PERF: Slightly more conservative delay before updating the diff
(setq diff-hl-flydiff-delay 0.5) ; default: 0.3
;; UX: get realtime feedback in diffs after staging/unstaging hunks.
(setq diff-hl-show-staged-changes nil)
;; UX: Update diffs when it makes sense too, without being too slow
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(when (modulep! :editor evil)
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
(map! :after diff-hl-show-hunk
:map diff-hl-show-hunk-map
:n "p" #'diff-hl-show-hunk-previous
:n "n" #'diff-hl-show-hunk-next
:n "c" #'diff-hl-show-hunk-copy-original-text
:n "r" #'diff-hl-show-hunk-revert-hunk
:n "[" #'diff-hl-show-hunk-previous
:n "]" #'diff-hl-show-hunk-next
:n "{" #'diff-hl-show-hunk-previous
:n "}" #'diff-hl-show-hunk-next
:n "S" #'diff-hl-show-hunk-stage-hunk))
;; UX: Refresh git-gutter on ESC or refocusing the Emacs frame.
(add-hook! '(doom-escape-hook doom-switch-window-hook) :append
(defun +vc-gutter-update-h (&rest _)
"Return nil to prevent shadowing other `doom-escape-hook' hooks."
(ignore (or inhibit-redisplay
(and (or (bound-and-true-p diff-hl-mode)
(bound-and-true-p diff-hl-dir-mode))
(diff-hl-update-once))))))
;; UX: Update diff-hl when magit alters git state.
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(when (modulep! :tools magit)
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
(add-hook 'magit-pre-refresh-hook #'diff-hl-magit-pre-refresh)
refactor(vc-gutter): remove redundant hooks The refresh hooks address the stage/unstage cases already.
2022-08-09 14:57:36 +02:00
(add-hook 'magit-post-refresh-hook #'diff-hl-magit-post-refresh))
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
feat(vc-gutter): shrink revert-hunk popup to contents
2022-08-09 17:54:18 +02:00
;; FIX: The revert popup consumes 50% of the frame, whether or not you're
;; reverting 2 lines or 20. This fix resizes the popup to match its contents.
(defadvice! +vc-gutter--shrink-popup-a (fn &rest args)
:around #'diff-hl-revert-hunk-1
(letf! ((refine-mode diff-auto-refine-mode)
(diff-auto-refine-mode t)
(defun diff-refine-hunk ()
(when refine-mode
(funcall diff-refine-hunk))
(shrink-window-if-larger-than-buffer)))
(apply fn args)))
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
;; UX: Don't delete the current hunk's indicators while we're editing
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(when (modulep! :editor evil)
fix(vc-gutter): remove advice removal for diff-hl-overlay-modified Originally, this intended to *stop* diff-hl from too aggressively deleting the diff overlays while editing. This is either no longer the case or the old advice was mistaken; the intended behavior is achieved without it.
2022-08-09 17:54:43 +02:00
(add-hook! 'diff-hl-flydiff-mode-hook
(defun +vc-gutter-init-flydiff-mode-h ()
(if (not diff-hl-flydiff-mode)
(remove-hook 'evil-insert-state-exit-hook #'diff-hl-flydiff-update)
(add-hook 'evil-insert-state-exit-hook #'diff-hl-flydiff-update)))))
feat(vc-gutter): add +diff-hl backend This adds an alternative backend to the :ui vc-gutter module, enabled with the +diff-hl flag. In the future, I intend for diff-hl to replace git-gutter, as it is slightly faster and depends on more native functionality (vc.el), but it's still a little buggy. It will remain opt-in until those issues are sorted out.
2022-08-08 17:46:31 +02:00
;; FIX: Reverting a hunk causes the cursor to be moved to an unexpected place,
;; often far from the target hunk.
(defadvice! +vc-gutter--save-excursion-a (fn &rest args)
"Suppresses unexpected cursor movement by `diff-hl-revert-hunk'."
:around #'diff-hl-revert-hunk
(let ((pt (point)))
(prog1 (apply fn args)
(goto-char pt)))))
Reference in a new issue Copy permalink