diff options
Diffstat (limited to 'modules/vc-config.el')
| -rw-r--r-- | modules/vc-config.el | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/modules/vc-config.el b/modules/vc-config.el new file mode 100644 index 00000000..4a556085 --- /dev/null +++ b/modules/vc-config.el @@ -0,0 +1,131 @@ +;;; vc-config.el --- Version Control Configuration -*- lexical-binding: t; coding: utf-8; -*- +;; author: Craig Jennings <c@cjennings.net> +;;; Commentary: +;; C-x g is my general entry to Magit's version control via the status page. + +;; Navigating changes in file happens via git gutter +;; - C-v d will allow jumping to changes +;; - C-v n and p will bring to next/previous changes + +;; Reviewing previous versions happens through git timemahine +;; - C-v t allows viewing this file by selecting a previous commit +;; - Once in timemachine, n and p will take you to previous/next commits +;; - To exit timemachine, press q in the read-only timemachine buffer + +;;; Code: + +;; ---------------------------- Magit Configuration ---------------------------- + +(use-package magit + :defer 0.5 + :bind ("C-x g" . magit-status) + :hook + (magit-log-mode . display-line-numbers-mode) + :custom + (magit-define-global-key-bindings 'default) + :config + (setq magit-bury-buffer-function 'magit-restore-window-configuration) + (setq git-commit-major-mode 'org-mode) ;; edit commit messages in org-mode + (setq magit-display-buffer-function + 'magit-display-buffer-fullframe-status-topleft-v1) + + ;; CLONING + (setq magit-clone-default-directory code-dir) ;; cloned repositories go here by default + (setq magit-clone-set-remote-head t) ;; do as git does for remote heads + (setq magit-clone-set-remote.pushDefault 'ask) ;; ask if origin is default + ) ;; end use-package magit + +;; --------------------------------- Git Gutter -------------------------------- +;; mark changed lines since last commit in the margin + +(use-package git-gutter + :defer t + :hook (prog-mode . git-gutter-mode) + :custom + (git-gutter:modified-sign "~") + (git-gutter:added-sign "+") + (git-gutter:deleted-sign "-") + (git-gutter:update-interval 0.05)) + +;; ------------------------------ Git Timemachine ------------------------------ + +(defun cj/git-timemachine () + "Open git snapshot with the selected version." + (interactive) + (unless (featurep 'git-timemachine) + (require 'git-timemachine)) + (git-timemachine--start #'cj/git-timemachine-show-selected-revision)) + +(use-package git-timemachine + :commands (git-timemachine + git-timemachine-show-revision + git-timemachine-show-selected-revision) + :init + (defun cj/git-timemachine-show-selected-revision () + "Displays git revisions of file in chronological order adding metadata." + (interactive) + (let* ((revisions (git-timemachine--revisions)) + (candidates (mapcar + (lambda (rev) + (concat (substring-no-properties (nth 0 rev) 0 7) + " | " + (or (nth 3 rev) "No date") + " | " + (nth 5 rev) + " | " + (nth 6 rev))) + revisions)) + ;; Create completion table with metadata to prevent sorting + (completion-table + (lambda (string pred action) + (if (eq action 'metadata) + ;; Tell vertico not to sort these candidates + '(metadata (display-sort-function . identity) + (cycle-sort-function . identity)) + (complete-with-action action candidates string pred))))) + (let* ((selected (completing-read "Select revision: " completion-table nil t)) + (index (cl-position selected candidates :test #'string=))) + (when index + (git-timemachine-show-revision (nth index revisions)))))) + + :bind (:map cj/vc-map + ("t" . cj/git-timemachine))) + +;; -------------------------------- Magit Forge -------------------------------- +;; GitHub/GitLab/etc integration for Magit + +(use-package forge + :after magit + :init + ;; Set up forge database location + (setq forge-database-file + (expand-file-name "forge-database.sqlite" user-emacs-directory)) + + :config + (setq forge-pull-notifications nil) ;; Don't pull notifications by default + (setq forge-topic-list-limit '(60 . 10))) ;; Show 60 open and 10 closed items + +(defun cj/forge-create-issue () + "Create a new issue in the current repository." + (interactive) + (if (forge-current-repository) + (forge-create-issue) + (user-error "Not in a forge repository"))) + +;; --------------------------------- VC Keymap --------------------------------- + +;; Ordering & sorting prefix and keymap +(define-prefix-command 'cj/vc-map nil + "Keymap for version control operations.") +(define-key cj/custom-keymap "v" 'cj/vc-map) +(define-key cj/vc-map "d" 'cj/goto-git-gutter-diff-hunks) +(define-key cj/vc-map "c" 'cj/forge-create-issue) +(define-key cj/vc-map "f" 'forge-pull) +(define-key cj/vc-map "i" 'forge-list-issues) +(define-key cj/vc-map "n" 'git-gutter:next-hunk) +(define-key cj/vc-map "p" 'git-gutter:previous-hunk) +(define-key cj/vc-map "r" 'forge-list-pullreqs) +(define-key cj/vc-map "t" 'cj/git-timemachine) + +(provide 'vc-config) +;;; vc-config.el ends here. |