aboutsummaryrefslogtreecommitdiff
path: root/.config/emacs/lisp/evil-collection/modes/magit-todos
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
committerJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
commitbdf9a71ab7baa2b1de9abcfd5df1a9107a55d141 (patch)
treec4524e6c41aa5107211103401dabfaefc81aa882 /.config/emacs/lisp/evil-collection/modes/magit-todos
parentfe3984f541bd32bdfa418afb305b614176b55ca0 (diff)
add a bunch of emacs packages HELP
Diffstat (limited to '.config/emacs/lisp/evil-collection/modes/magit-todos')
-rw-r--r--.config/emacs/lisp/evil-collection/modes/magit-todos/README.org32
-rw-r--r--.config/emacs/lisp/evil-collection/modes/magit-todos/evil-collection-magit-todos.el62
2 files changed, 94 insertions, 0 deletions
diff --git a/.config/emacs/lisp/evil-collection/modes/magit-todos/README.org b/.config/emacs/lisp/evil-collection/modes/magit-todos/README.org
new file mode 100644
index 0000000..17a94d1
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/magit-todos/README.org
@@ -0,0 +1,32 @@
+* magit-todos
+
+ Evil bindings for [[https://github.com/alphapapa/magit-todos][magit-todos]].
+
+ Setup clears =j= and =k= on the todos section maps (older =magit-todos=
+ versions bound them, blocking evil's vertical motion through todos
+ sections) and adds a jump key on =magit-status=.
+
+** Key bindings
+
+*** magit-todos-section-map / magit-todos-item-section-map
+
+ | Key | Original | Evil |
+ |-----+------------------------------------+---------|
+ | =j= | =magit-todos-...= (older versions) | unbound |
+ | =k= | =magit-todos-...= (older versions) | unbound |
+
+ The current upstream uses =B= / =b= on these maps (branch list set
+ commit / toggle); those are untouched.
+
+*** magit-status-mode-map (normal state)
+
+ | Command | Original | Evil |
+ |-----------------------------+----------+------|
+ | =magit-todos-jump-to-todos= | =j T= | =gT= |
+
+ Bound only when =magit-todos-mode= is enabled.
+
+** Notes
+
+ =magit-todos-mode= emits a warning about the =jT= key when these
+ rebindings take effect. Setup advises the mode to silence that warning.
diff --git a/.config/emacs/lisp/evil-collection/modes/magit-todos/evil-collection-magit-todos.el b/.config/emacs/lisp/evil-collection/modes/magit-todos/evil-collection-magit-todos.el
new file mode 100644
index 0000000..891904b
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/magit-todos/evil-collection-magit-todos.el
@@ -0,0 +1,62 @@
+;;; evil-collection-magit-todos.el --- Bindings for `magit-todos' -*- lexical-binding: t -*-
+
+;; Copyright (C) 2018 James Nguyen
+
+;; Author: Fredrik Bergroth <fbergroth@gmail.com>
+;; Maintainer: James Nguyen <james@jojojames.com>
+;; Pierre Neidhardt <mail@ambrevar.xyz>
+;; URL: https://github.com/emacs-evil/evil-collection
+;; Version: 0.0.1
+;; Package-Requires: ((emacs "26.3"))
+;; Keywords: evil, emacs, tools
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;; Bindings for `magit-todos'.
+
+;;; Code:
+(require 'evil-collection)
+(require 'magit-todos nil t)
+
+(defconst evil-collection-magit-todos-maps '(magit-todos-section-map
+ magit-todos-item-section-map
+ magit-status-mode-map))
+
+(defun evil-collection-magit-todos-setup-jump-key ()
+ "Add keybinding to jump to todos section."
+ (evil-collection-define-key 'normal 'magit-status-mode-map
+ "gT" (and (bound-and-true-p magit-todos-mode) 'magit-todos-jump-to-todos)))
+
+(defun evil-collection-magit-todos-supress-warning (func &rest args)
+ "Supress the jT keybinding warning."
+ (cl-letf* (((symbol-function 'message) #'ignore))
+ (apply func args)))
+
+;;;###autoload
+(defun evil-collection-magit-todos-setup ()
+ "Set up `evil' bindings for `magit-todos'."
+ ;; magit-todos binds jT and k which prevents evil users from stepping into the section
+ (dolist (key '("j" "k"))
+ (evil-collection-define-key nil 'magit-todos-section-map key nil)
+ (evil-collection-define-key nil 'magit-todos-item-section-map key nil))
+
+ ;; No need to tell me that jT isn't bound
+ (advice-add 'magit-todos-mode :around 'evil-collection-magit-todos-supress-warning)
+
+ (add-hook 'magit-todos-mode-hook 'evil-collection-magit-todos-setup-jump-key))
+
+
+(provide 'evil-collection-magit-todos)
+;;; evil-collection-magit-todos.el ends here