1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
;;; magit-reflog.el --- Inspect ref history -*- lexical-binding:t -*-
;; Copyright (C) 2008-2025 The Magit Project Contributors
;; Author: Jonas Bernoulli <emacs.magit@jonas.bernoulli.dev>
;; Maintainer: Jonas Bernoulli <emacs.magit@jonas.bernoulli.dev>
;; SPDX-License-Identifier: GPL-3.0-or-later
;; Magit 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.
;;
;; Magit 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 Magit. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This library implements support for looking at Git reflogs.
;;; Code:
(require 'magit-core)
(require 'magit-log)
;;; Options
(defcustom magit-reflog-limit 256
"Maximal number of entries initially shown in reflog buffers.
The limit in the current buffer can be changed using \"+\"
and \"-\"."
:package-version '(magit . "3.0.0")
:group 'magit-commands
:type 'number)
(defcustom magit-reflog-margin
(list (nth 0 magit-log-margin)
(nth 1 magit-log-margin)
'magit-log-margin-width nil
(nth 4 magit-log-margin))
"Format of the margin in `magit-reflog-mode' buffers.
The value has the form (INIT STYLE WIDTH AUTHOR AUTHOR-WIDTH).
If INIT is non-nil, then the margin is shown initially.
STYLE controls how to format the author or committer date.
It can be one of `age' (to show the age of the commit),
`age-abbreviated' (to abbreviate the time unit to a character),
or a string (suitable for `format-time-string') to show the
actual date. Option `magit-log-margin-show-committer-date'
controls which date is being displayed.
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
AUTHOR controls whether the name of the author is also shown by
default.
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so."
:package-version '(magit . "2.9.0")
:group 'magit-log
:group 'magit-margin
:type magit-log-margin--custom-type
:initialize #'magit-custom-initialize-reset
:set-after '(magit-log-margin)
:set (apply-partially #'magit-margin-set-variable 'magit-reflog-mode))
;;; Faces
(defface magit-reflog-commit '((t :foreground "green"))
"Face for commit commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-amend '((t :foreground "magenta"))
"Face for amend commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-merge '((t :foreground "green"))
"Face for merge, checkout and branch commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-checkout '((t :foreground "blue"))
"Face for checkout commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-reset '((t :foreground "red"))
"Face for reset commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-rebase '((t :foreground "magenta"))
"Face for rebase commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-cherry-pick '((t :foreground "green"))
"Face for cherry-pick commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-remote '((t :foreground "cyan"))
"Face for pull and clone commands in reflogs."
:group 'magit-faces)
(defface magit-reflog-other '((t :foreground "cyan"))
"Face for other commands in reflogs."
:group 'magit-faces)
;;; Commands
;;;###autoload
(defun magit-reflog-current ()
"Display the reflog of the current branch.
If `HEAD' is detached, then show the reflog for that instead."
(interactive)
(magit-reflog-setup-buffer (or (magit-get-current-branch) "HEAD")))
;;;###autoload
(defun magit-reflog-other (ref)
"Display the reflog of a branch or another ref."
(interactive (list (magit-read-local-branch-or-ref "Show reflog for")))
(magit-reflog-setup-buffer ref))
;;;###autoload
(defun magit-reflog-head ()
"Display the `HEAD' reflog."
(interactive)
(magit-reflog-setup-buffer "HEAD"))
;;; Mode
(defvar-keymap magit-reflog-mode-map
:doc "Keymap for `magit-reflog-mode'."
:parent magit-log-mode-map
"C-c C-n" #'undefined
"L" #'magit-margin-settings)
(define-derived-mode magit-reflog-mode magit-mode "Magit Reflog"
"Mode for looking at Git reflog.
This mode is documented in info node `(magit)Reflog'.
\\<magit-mode-map>\
Type \\[magit-refresh] to refresh the current buffer.
Type \\[magit-visit-thing] or \\[magit-diff-show-or-scroll-up] \
to visit the commit at point.
Type \\[magit-cherry-pick] to apply the commit at point.
Type \\[magit-reset] to reset `HEAD' to the commit at point.
\\{magit-reflog-mode-map}"
:interactive nil
:group 'magit-log
(magit-hack-dir-local-variables)
(setq magit--imenu-item-types 'commit))
(defun magit-reflog-setup-buffer (ref)
(require 'magit)
(magit-setup-buffer #'magit-reflog-mode nil
(magit-buffer-refname ref)
(magit-buffer-log-args (list (format "-n%s" magit-reflog-limit)))))
(defun magit-reflog-refresh-buffer ()
(magit-set-header-line-format (concat "Reflog for " magit-buffer-refname))
(magit-insert-section (reflogbuf)
(magit-git-wash (apply-partially #'magit-log-wash-log 'reflog)
"reflog" "show" "--format=%h%x00%aN%x00%gd%x00%gs" "--date=raw"
magit-buffer-log-args magit-buffer-refname "--")))
(cl-defmethod magit-buffer-value (&context (major-mode magit-reflog-mode))
magit-buffer-refname)
(defvar magit-reflog-labels
'(("commit" . magit-reflog-commit)
("amend" . magit-reflog-amend)
("merge" . magit-reflog-merge)
("checkout" . magit-reflog-checkout)
("branch" . magit-reflog-checkout)
("reset" . magit-reflog-reset)
("rebase" . magit-reflog-rebase)
("rewritten" . magit-reflog-rebase)
("cherry-pick" . magit-reflog-cherry-pick)
("initial" . magit-reflog-commit)
("pull" . magit-reflog-remote)
("clone" . magit-reflog-remote)
("autosave" . magit-reflog-commit)
("restart" . magit-reflog-reset)))
(defun magit-reflog-format-subject (subject)
(let* ((match (string-match magit-reflog-subject-re subject))
(command (and match (match-str 1 subject)))
(option (and match (match-str 2 subject)))
(type (and match (match-str 3 subject)))
(label (if (string= command "commit")
(or type command)
command))
(text (if (string= command "commit")
label
(string-join (delq nil (list command option type)) " "))))
(format "%-16s "
(magit--propertize-face
text (or (cdr (assoc label magit-reflog-labels))
'magit-reflog-other)))))
;;; _
(provide 'magit-reflog)
;; Local Variables:
;; read-symbol-shorthands: (
;; ("and$" . "cond-let--and$")
;; ("and>" . "cond-let--and>")
;; ("and-let" . "cond-let--and-let")
;; ("if-let" . "cond-let--if-let")
;; ("when-let" . "cond-let--when-let")
;; ("while-let" . "cond-let--while-let")
;; ("match-string" . "match-string")
;; ("match-str" . "match-string-no-properties"))
;; End:
;;; magit-reflog.el ends here
|