Files
dotfiles/thoom-emacs/ThoomEmacs.org

19 KiB

Thoom Emacs

DONE Prelude

Package Management - Elpaca

(defvar elpaca-installer-version 0.7)
(defvar elpaca-directory (expand-file-name "elpaca/" user-emacs-directory))
(defvar elpaca-builds-directory (expand-file-name "builds/" elpaca-directory))
(defvar elpaca-repos-directory (expand-file-name "repos/" elpaca-directory))
(defvar elpaca-order '(elpaca :repo "https://github.com/progfolio/elpaca.git"
                              :ref nil :depth 1
                              :files (:defaults "elpaca-test.el" (:exclude "extensions"))
                              :build (:not elpaca--activate-package)))
(let* ((repo  (expand-file-name "elpaca/" elpaca-repos-directory))
       (build (expand-file-name "elpaca/" elpaca-builds-directory))
       (order (cdr elpaca-order))
       (default-directory repo))
  (add-to-list 'load-path (if (file-exists-p build) build repo))
  (unless (file-exists-p repo)
    (make-directory repo t)
    (when (< emacs-major-version 28) (require 'subr-x))
    (condition-case-unless-debug err
        (if-let ((buffer (pop-to-buffer-same-window "*elpaca-bootstrap*"))
                 ((zerop (apply #'call-process `("git" nil ,buffer t "clone"
                                                 ,@(when-let ((depth (plist-get order :depth)))
                                                     (list (format "--depth=%d" depth) "--no-single-branch"))
                                                 ,(plist-get order :repo) ,repo))))
                 ((zerop (call-process "git" nil buffer t "checkout"
                                       (or (plist-get order :ref) "--"))))
                 (emacs (concat invocation-directory invocation-name))
                 ((zerop (call-process emacs nil buffer nil "-Q" "-L" "." "--batch"
                                       "--eval" "(byte-recompile-directory \".\" 0 'force)")))
                 ((require 'elpaca))
                 ((elpaca-generate-autoloads "elpaca" repo)))
            (progn (message "%s" (buffer-string)) (kill-buffer buffer))
          (error "%s" (with-current-buffer buffer (buffer-string))))
      ((error) (warn "%s" err) (delete-directory repo 'recursive))))
  (unless (require 'elpaca-autoloads nil t)
    (require 'elpaca)
    (elpaca-generate-autoloads "elpaca" repo)
    (load "./elpaca-autoloads")))
(add-hook 'after-init-hook #'elpaca-process-queues)
(elpaca `(,@elpaca-order))

(elpaca elpaca-use-package
        (elpaca-use-package-mode))
;; Wait for elpaca-use-package to finish installing before proceding
(elpaca-wait)

Utility constants for checking operating system

;; Check the system used
(defconst ON-LINUX   (eq system-type 'gnu/linux))
(defconst ON-MAC     (eq system-type 'darwin))
(defconst ON-BSD     (or ON-MAC (eq system-type 'berkeley-unix)))
(defconst ON-WINDOWS (memq system-type '(cygwin windows-nt ms-dos)))

Fix PATH on macOS

Emacs on macOS doesn't naturally find shell variables like PATH, so to help it out we run a shell and load some variables from the env command.

(use-package exec-path-from-shell
  :straight t
  :if (and ON-MAC (memq window-system '(mac ns)))
  :config
  (dolist (var '("NIX_SSL_CERT_FILE"
         "NIX_PATH"
         "NIX_PROFILES"))
    (add-to-list 'exec-path-from-shell-variables var))
  (exec-path-from-shell-initialize))

Auto-tangle this file

(defun thoom/org-babel-tangle-config ()
  (when (string-equal (file-truename (buffer-file-name))
              (expand-file-name "~/.dotfiles/thoom-emacs/ThoomEmacs.org"))
    ;; Dynamic scoping to the rescue
    (let ((org-confirm-babel-evaluate nil))
      (org-babel-tangle))))

(add-hook 'org-mode-hook (lambda () (add-hook 'after-save-hook #'thoom/org-babel-tangle-config)))

DONE Basic UI Tweaks

Theme

(use-package doom-themes
  :straight t
  :config
  ;; Global settings (defaults)
  (setq doom-themes-enable-bold t    ; if nil, bold is universally disabled
        doom-themes-enable-italic t) ; if nil, italics is universally disabled
  (load-theme 'doom-one t)

  ;; Enable flashing mode-line on errors
  (doom-themes-visual-bell-config)
  ;; Corrects (and improves) org-mode's native fontification.
  (doom-themes-org-config))

Transparency

(set-frame-parameter (selected-frame) 'alpha '(99 98))
(add-to-list 'default-frame-alist '(alpha 99 98))

Hiding Clutter

Disable a bunch of stuff we don't want to see.

(setq inhibit-startup-message t
      use-dialog-box nil)

(tool-bar-mode -1)
(scroll-bar-mode -1)

;; On a Mac, the menu bar doesn't take up screen real-estate, so leave it on
(unless ON-MAC
  (menu-bar-mode -1))

General Settings

Set some common settings, like global-auto-revert-mode.

(setq-default scroll-error-top-bottom t)

;; Revert buffers when the underlying file has changed
(global-auto-revert-mode 1)

;; Remember recent files
(recentf-mode 1)

;; Save what you enter into minibuffer prompts
(setq history-length 25)
(savehist-mode 1)

;; Visually mark the line the cursor is on
(global-hl-line-mode 1)

;; TODO - Decide whether to enable this
;; (defalias 'yes-or-no-p 'y-or-n-p)

;; tabs are for monsters
(setq-default indent-tabs-mode nil)
(setq-default tab-width 4)
(setq-default sentence-end-double-space nil)

hl-todo

(use-package hl-todo
  :straight t
  :init
  (global-hl-todo-mode))

Repeat Mode

Repeat-mode just needs to be enabled. Keymaps are defined through use-package's :repeat-map directive.

(repeat-mode 1)

Tab Bar

(tab-bar-mode)

;; TODO - keybindings

Custom File

Set a location for the custom file so it doesn't pollute this file.

(setq custom-file (locate-user-emacs-file "custom-vars.el"))

Emacs Server

(require 'server)
(unless (server-running-p) (server-start))

Keybindings

DONE Which-key

(use-package which-key
  :straight t
  :init
  (which-key-mode)
  (which-key-setup-side-window-bottom))

WAIT Keybindings

(use-package emacs
  :bind
  ;; Window management
  (("C-c w v" . split-window-right)
   ("C-c w s" . split-window-below)
   ("C-S-h" . windmove-left)
   ("C-S-j" . windmove-down)
   ("C-S-k" . windmove-up)
   ("C-S-l" . windmove-right)

   ;; Tab management
   ("C-c w t c" . tab-bar-new-tab)
   ("C-c w t r" . tab-rename)
   ("C-c w t d" . tab-bar-close-tab)
   ("C-c w t n" . tab-bar-switch-to-next-tab)
   ("C-c w t p" . tab-bar-switch-to-prev-tab)
   ;; Mac keybindings for tab management
   ("s-t" . tab-bar-new-tab)
   ("s-}" . tab-bar-switch-to-next-tab)
   ("s-{" . tab-bar-switch-to-prev-tab)
   ;; Common keybindings with tab switching in browsers, for use with my mouse bindings
   ("C-<next>" . tab-bar-switch-to-next-tab)
   ("C-<prior>" . tab-bar-switch-to-prev-tab)

   ;; Buffer management
   ("C-c b d" . kill-this-buffer)
   ("C-c b b" . consult-buffer)
   ("C-c b p" . previous-buffer)
   ("C-c b n" . next-buffer)
   ("C-c b C-c" . server-edit)

   ;; File management
   ("C-c f f" . find-file)
   ("C-c f r" . consult-recent-file)
   ("C-c f j" . dired-jump)

   ;; TODO - C-c g p for open project in magit

   ("C-o" . pop-global-mark)
   ("M-DEL" . backward-kill-word)
   ("C-:" . execute-extended-command-for-buffer))
  :init
  ;; mark-page is not very useful, and shadows project.el bindings in Meow keypad
  (unbind-key "C-x C-p"))

DONE Dired

(use-package dired
  :bind (:map dired-mode-map
              ("h" . dired-up-directory)
              ("l" . dired-find-file)))

Editing

WAIT Fancy Indenting

When in indent-rigidly mode (+ in normal state), use H/L to adjust indent by single character increments and h/l to adjust by tab stops.

;; TODO - define keys to move region up and down by lines
(define-key indent-rigidly-map (kbd "H") 'indent-rigidly-left)
(define-key indent-rigidly-map (kbd "L") 'indent-rigidly-right)
(define-key indent-rigidly-map (kbd "h") 'indent-rigidly-left-to-tab-stop)
(define-key indent-rigidly-map (kbd "l") 'indent-rigidly-right-to-tab-stop)

DONE Autocompletion

(use-package corfu
  :straight t
  ;; Optional customizations
  ;; :custom
  ;; (corfu-cycle t)                ;; Enable cycling for `corfu-next/previous'
  ;; (corfu-auto t)                 ;; Enable auto completion
  ;; (corfu-separator ?\s)          ;; Orderless field separator
  ;; (corfu-quit-at-boundary nil)   ;; Never quit at completion boundary
  ;; (corfu-quit-no-match nil)      ;; Never quit, even if there is no match
  ;; (corfu-preview-current nil)    ;; Disable current candidate preview
  ;; (corfu-preselect-first nil)    ;; Disable candidate preselection
  ;; (corfu-on-exact-match nil)     ;; Configure handling of exact matches
  ;; (corfu-echo-documentation nil) ;; Disable documentation in the echo area
  ;; (corfu-scroll-margin 5)        ;; Use scroll margin

  ;; Enable Corfu only for certain modes.
  ;; :hook ((prog-mode . corfu-mode)
  ;;        (shell-mode . corfu-mode)
  ;;        (eshell-mode . corfu-mode))

  ;; Recommended: Enable Corfu globally.
  ;; This is recommended since Dabbrev can be used globally (M-/).
  ;; See also `corfu-excluded-modes'.
  :init
  (global-corfu-mode))

(use-package emacs
  :init
  (setq tab-always-indent 'complete))

DONE Dumb-Jump

(use-package dumb-jump
  :straight t
  :config
  (add-hook 'xref-backend-functions #'dumb-jump-xref-activate)
  (setq xref-show-definitions-function #'xref-show-definitions-completing-read))

Org

(use-package org
  :hook (org-mode . visual-line-mode)
  :bind (:map
         org-mode-map
         ("C-x C-o c" . thoom-org-clear-all)
         :repeat-map
         thoom/org-previous-next-visible-heading-repeat-map
         ("n" . org-next-visible-heading)
         ("C-n" . org-next-visible-heading)
         ("p" . org-previous-visible-heading)
         ("C-p" . org-previous-visible-heading))
  :config
  ;; Add structure templates
  (add-to-list 'org-modules 'org-tempo t)
  (add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp"))

  (setq org-edit-src-content-indentation 0))

(use-package org-bullets
  :straight t
  :hook org-mode)

DONE Groceries

(defun thoom-org-clear-all ()
  (interactive)
  (goto-char 0)
  (org-map-entries
   (lambda ()
     (org-todo "")))
  (flush-lines "CLOSED")
  (message "Entries cleared."))

VMOCE

DONE Vertico

(use-package vertico
  :straight (:files (:defaults "extensions/*"))
  :init
  (vertico-mode)

  :bind (:map vertico-map
          ("C-j" . vertico-next)
          ("C-k" . vertico-previous)))

(use-package vertico-directory
  :after vertico
  :bind (:map vertico-map
          ("C-h" . vertico-directory-delete-word)
          ("C-l" . vertico-directory-enter)))

DONE Marginalia

(use-package marginalia
  :straight t
  ;; Either bind `marginalia-cycle' globally or only in the minibuffer
  :bind (:map minibuffer-local-map
          ("M-A" . marginalia-cycle))

  :init
  (marginalia-mode))

DONE Orderless

(use-package orderless
  :straight t
  :init
  ;; Configure a custom style dispatcher (see the Consult wiki)
  ;; (setq orderless-style-dispatchers '(+orderless-dispatch)
  ;;       orderless-component-separator #'orderless-escapable-split-on-space)
  (setq completion-styles '(orderless basic)
    completion-category-defaults nil
    completion-category-overrides '((file (styles partial-completion)))))

DONE Consult

(use-package consult
  :straight t
  ;; Replace bindings. Lazily loaded due by `use-package'.
  :bind (;; C-c bindings (mode-specific-map)
     ("C-c h" . consult-history)
     ("C-c m" . consult-mode-command)
     ("C-c k" . consult-kmacro)
     ;; C-x bindings (ctl-x-map)
     ("C-x M-:" . consult-complex-command)     ;; orig. repeat-complex-command
     ("C-x C-b" . consult-buffer)
     ("C-x b" . consult-buffer)                ;; orig. switch-to-buffer
     ("C-x 4 b" . consult-buffer-other-window) ;; orig. switch-to-buffer-other-window
     ("C-x 5 b" . consult-buffer-other-frame)  ;; orig. switch-to-buffer-other-frame
     ("C-x r b" . consult-bookmark)            ;; orig. bookmark-jump
     ("C-x p b" . consult-project-buffer)      ;; orig. project-switch-to-buffer
     ;; Custom M-# bindings for fast register access
     ("M-#" . consult-register-load)
     ("M-'" . consult-register-store)          ;; orig. abbrev-prefix-mark (unrelated)
     ("C-M-#" . consult-register)
     ;; Other custom bindings
     ("M-y" . consult-yank-pop)                ;; orig. yank-pop
     ("<help> a" . consult-apropos)            ;; orig. apropos-command
     ;; M-g bindings (goto-map)
     ("M-g e" . consult-compile-error)
     ("M-g f" . consult-flymake)               ;; Alternative: consult-flycheck
     ("M-g g" . consult-goto-line)             ;; orig. goto-line
     ("M-g M-g" . consult-goto-line)           ;; orig. goto-line
     ("M-g o" . consult-outline)               ;; Alternative: consult-org-heading
     ("M-g m" . consult-mark)
     ("M-g k" . consult-global-mark)
     ("M-g i" . consult-imenu)
     ("M-g I" . consult-imenu-multi)
     ;; M-s bindings (search-map)
     ("M-s d" . consult-find)
     ("M-s D" . consult-locate)
     ("M-s g" . consult-grep)
     ("M-s G" . consult-git-grep)
     ("M-s r" . consult-ripgrep)
     ("M-s l" . consult-line)
     ("M-s L" . consult-line-multi)
     ("M-s m" . consult-multi-occur)
     ("M-s k" . consult-keep-lines)
     ("M-s u" . consult-focus-lines)
     ;; Isearch integration
     ("M-s e" . consult-isearch-history)
     :map isearch-mode-map
     ("M-e" . consult-isearch-history)         ;; orig. isearch-edit-string
     ("M-s e" . consult-isearch-history)       ;; orig. isearch-edit-string
     ("M-s l" . consult-line)                  ;; needed by consult-line to detect isearch
     ("M-s L" . consult-line-multi)            ;; needed by consult-line to detect isearch
     ;; Minibuffer history
     :map minibuffer-local-map
     ("M-s" . consult-history)                 ;; orig. next-matching-history-element
     ("M-r" . consult-history))                ;; orig. previous-matching-history-element

  ;; Enable automatic preview at point in the *Completions* buffer. This is
  ;; relevant when you use the default completion UI.
  :hook (completion-list-mode . consult-preview-at-point-mode)

  ;; The :init configuration is always executed (Not lazy)
  :init

  ;; Optionally configure the register formatting. This improves the register
  ;; preview for `consult-register', `consult-register-load',
  ;; `consult-register-store' and the Emacs built-ins.
  (setq register-preview-delay 0.5
    register-preview-function #'consult-register-format)

  ;; Optionally tweak the register preview window.
  ;; This adds thin lines, sorting and hides the mode line of the window.
  (advice-add #'register-preview :override #'consult-register-window)

  ;; Use Consult to select xref locations with preview
  (setq xref-show-xrefs-function #'consult-xref
    xref-show-definitions-function #'consult-xref)

  ;; Configure other variables and modes in the :config section,
  ;; after lazily loading the package.
  :config

  ;; Optionally configure preview. The default value
  ;; is 'any, such that any key triggers the preview.
  ;; (setq consult-preview-key 'any)
  ;; (setq consult-preview-key (kbd "M-."))
  ;; (setq consult-preview-key (list (kbd "<S-down>") (kbd "<S-up>")))
  ;; For some commands and buffer sources it is useful to configure the
  ;; :preview-key on a per-command basis using the `consult-customize' macro.
  (consult-customize
   consult-theme
   :preview-key '(:debounce 0.2 any)
   consult-ripgrep consult-git-grep consult-grep
   consult-bookmark consult-recent-file consult-xref
   consult--source-bookmark consult--source-recent-file
   consult--source-project-recent-file
   :preview-key (kbd "M-."))

  ;; Optionally configure the narrowing key.
  ;; Both < and C-+ work reasonably well.
  (setq consult-narrow-key "<") ;; (kbd "C-+")

  ;; Optionally make narrowing help available in the minibuffer.
  ;; You may want to use `embark-prefix-help-command' or which-key instead.
  ;; (define-key consult-narrow-map (vconcat consult-narrow-key "?") #'consult-narrow-help)

  ;; By default `consult-project-function' uses `project-root' from project.el.
  ;; Optionally configure a different project root function.
  ;; There are multiple reasonable alternatives to chose from.
  ;;;; 1. project.el (the default)
  ;; (setq consult-project-function #'consult--default-project--function)
  ;;;; 2. projectile.el (projectile-project-root)
  ;; (autoload 'projectile-project-root "projectile")
  ;; (setq consult-project-function (lambda (_) (projectile-project-root)))
  ;;;; 3. vc.el (vc-root-dir)
  ;; (setq consult-project-function (lambda (_) (vc-root-dir)))
  ;;;; 4. locate-dominating-file
  ;; (setq consult-project-function (lambda (_) (locate-dominating-file "." ".git")))
  )

DONE Embark

(use-package embark
  :straight t

  :bind
  (("C-." . embark-act)         ;; pick some comfortable binding
   ("C-;" . embark-dwim)        ;; good alternative: M-.
   ("C-h B" . embark-bindings)) ;; alternative for `describe-bindings'

  :init
  ;; Optionally replace the key help with a completing-read interface
  (setq prefix-help-command #'embark-prefix-help-command)

  :config
  ;; Hide the mode line of the Embark live/completions buffers
  (add-to-list 'display-buffer-alist
           '("\\`\\*Embark Collect \\(Live\\|Completions\\)\\*"
         nil
         (window-parameters (mode-line-format . none)))))

;; Consult users will also want the embark-consult package.
(use-package embark-consult
  :straight t
  :after (embark consult)
  :demand t ; only necessary if you have the hook below
  ;; if you want to have consult previews as you move around an
  ;; auto-updating embark collect buffer
  :hook
  (embark-collect-mode . consult-preview-at-point-mode))

DONE Git

(use-package magit
  :straight t
  :custom (magit-save-repository-buffers 'dontask)
  :bind (("C-x g" . magit-status)
     :map magit-mode-map
     (":" . execute-extended-command)
     ("x" . magit-discard)))

DONE Direnv

(use-package direnv
  :straight t
  :config
  (direnv-mode))

Programming

TODO LSP

TODO Python

TODO Web

TODO Nix