Skip to content

Latest commit

 

History

History
2860 lines (2567 loc) · 95.6 KB

emacs-config.org

File metadata and controls

2860 lines (2567 loc) · 95.6 KB

Emacs configuration

Introduction

  • State “TODO” from [2025-01-20 Mon 23:48]

Emacs customisation generates init.el and other emacs elisp utility files using org-babel-tangle.

Own libraries

These libraries are seperate stand alone github libraries.

el-docstring-sap

Provides docstring help for symbol at point.

https://github.com/rileyrg/el-docstring-sap

lazy-lang-learn

A small “game” like utility that displays snippets to glance at. You can then invoke google translate on them. Stores history.

https://github.com/rileyrg/lazy-lang-learn

early-init

Emacs early-init https://www.gnu.org/software/emacs/manual/html_node/emacs/Early-Init-File.html

redirect emacs cache

;;; early-init.el --- early bird  -*- no-byte-compile: t -*-
;; Maintained in emacs-config.org
(when (boundp 'native-comp-eln-load-path)
  (startup-redirect-eln-cache "var/eln-cache"))
(setq max-specpdl-size 13000)

elpaca

(setq package-enable-at-startup nil)

elisp locations

(defcustom rgr/elisp-dir (expand-file-name  "etc/elisp" user-emacs-directory) "Where user elisp files should be stored")
(defun rgr/user-elisp-file(f)
  (expand-file-name f rgr/elisp-dir))
(add-to-list 'load-path rgr/elisp-dir)

emacs main init

debug init

  ;; look for a debug init file and load, trigger the debugger
(defun debug-init (&optional fname)
  (let* ((fname (if fname fname "debug-init.el"))
         (debug-init (expand-file-name fname user-emacs-directory)))
    (if (file-exists-p debug-init)
        (progn
          (message "A debug-init, %s, was found, so loading." debug-init)
          (let ((rgr/debug-init-debugger t)) ;; can set rgr/debug-init-debugger to false in the debug init to avoid triggering the debugger
            (load-file debug-init)
            (if rgr/debug-init-debugger
                (debug)
              (message " After loading %s `rgr/debug-init-debugger was set to nil so not debugging." debug-init))))
      (message "No debug initfile, %s, found so ignoring" debug-init))))
(debug-init)

package management

own projects

(defcustom rgr/emacs-project-dir "~/development/emacs" "personal elisp libraries" )

elpaca

(defvar elpaca-installer-version 0.8)
(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))

;; Install use-package support
(elpaca elpaca-use-package
  ;; Enable use-package :ensure support for Elpaca.
  (elpaca-use-package-mode))

custom.el

(setq custom-file  (expand-file-name  "custom.el" user-emacs-directory))
(load custom-file 'noerror)

no-littering - keep data tidy

;; put extra emacs-lisp files into etc/elisp
(let ((default-directory rgr/elisp-dir))
  (normal-top-level-add-subdirs-to-load-path))

(use-package no-littering
  :custom
  (make-backup-files t)
  :config
  (setq backup-directory-alist
        `(("." . ,(no-littering-expand-var-file-name "backup/"))))
  (setq auto-save-file-name-transforms
        `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))

notifications

(require 'notifications)
(defun emacs-alert(m &optional rest)
  (notifications-notify
   :title "Emacs"
   :body (format m rest)))

startup hooks

(defun rgr/startup-hook ()
  (if rgr/session-history
      (set-face-background 'mode-line "lightgreen")
    (set-face-background 'mode-line "orangered"))
  (when (daemonp)
    (set-frame-name (format "Emacs-%s" (daemonp))))
  (if (string= "general" (daemonp))
      (switch-to-buffer (recentf-open-most-recent-file 1))))

(if (daemonp)
    (add-hook 'server-after-make-frame-hook #'rgr/startup-hook)
  (add-hook 'emacs-startup-hook 'rgr/startup-hook))

(defun rgr/quit-or-close-emacs(&optional kill)
  (interactive)
  (if (or current-prefix-arg kill)
      (rgr/server-shutdown)
    (delete-frame)))

(defun rgr/server-shutdown ()
  "Save buffers, Quit, and Shutdown (kill) server"
  (interactive)
  (save-buffers-kill-emacs))

(global-set-key (kbd "C-c x")  'rgr/quit-or-close-emacs)

load other inits

;; we always load general init, but if its not the command line choice or a non daemon, dont keep history etc.
(setq rgr/session-history (if (or (not (daemonp)) (string= "general" (daemonp))) 't nil))
(setq  rgr/irc-session (string= "irc" (daemonp)))

;; unless no daemon, or the daemon name begins with "_" underscore, load the init-general.
(if (or (not (daemonp)) (not (string-match-p "^_.*$" (daemonp))))
    (load-file (rgr/user-elisp-file "init-general.el"))
  (emacs-alert "Suppressing loading of init-general for %s" (daemonp)))

;; now load daemon specific init file
(if (and (daemonp) (not (string= (daemonp) "general")))
    (let((f (rgr/user-elisp-file (format "init-%s.el" (daemonp)))))
      (when (file-exists-p f)
        (set-face-background 'mode-line "orange")
        (emacs-alert (format "loading daemon init file : %s" f))
        (load-file  f))))

  

general init

startup

(emacs-alert (format "%s ... is starting up..." (daemonp)))

(if rgr/session-history
    (progn 
      (recentf-mode)
      (save-place-mode)
      (savehist-mode)))

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

Load early stuff / gpg

Load all files in certain directories.
(defun load-el-gpg (load-dir)
  (message "attempting mass load from %s." load-dir)
  (when (file-exists-p load-dir)
    (dolist (f (directory-files-recursively load-dir "\.[el|gpg]$"))
      (condition-case nil
          (progn
            (message "load-el-gpg loading %s" f)
            (load f 'no-error))
        (error nil)))))
(load-el-gpg (expand-file-name "etc/early-load" user-emacs-directory))

host specific

Stick a custom in here. eg my thinkpad custom file.

(load-el-gpg (expand-file-name (system-name)  (expand-file-name "etc/hosts" user-emacs-directory)))

Security

Auth-Sources, get-auth-info

Let emacs take care of security things automagically. example:
(setq passw (get-auth-info "licenses" "my-auth-token"))
(require 'auth-source)
(setq auth-sources '("~/.gnupg/auth/authinfo.gpg" "~/.gnupg/auth/authirc.gpg"))
(defun get-auth-info (host user &optional port)
  "Interface to `auth-source-search' to fetch a secret for the HOST and USER."
  (let* ((info (nth 0 (auth-source-search
                       :host host
                       :user user
                       :port port
                       :require '(:user :secret)
                       :create nil)))
         (secret (plist-get info :secret)))
    (if (functionp secret)
        (funcall secret)
      secret)))

Pass

Uses the unix command line pass utility. Can be used via process-lines e.g

;;(car (process-lines "pass" "Chat/slack-api-token"))

themes

modus themes

https://github.com/protesilaos/modus-themes
(use-package modus-themes
                                        ;:disabled
  :init
  ;; Add all your customizations prior to loading the themes
  (setq modus-themes-slanted-constructs t
        modus-themes-bold-constructs nil)

  ;; Load the theme files before enabling a theme
  ;; (modus-themes-load-themes)
  :config
  (load-theme 'modus-operandi :no-confirm))
;; (modus-themes-load-vivendi))

Project Management

use emacs project package

(use-package project
  :custom
  (project-vc-extra-root-markers '(".project"))
  :config
  (define-key project-prefix-map "v" '("vterm" .  multi-vterm-project))
  (define-key project-prefix-map "u" '("project url" .  rgr/project-url)))

add project based TODO

(setq project-org-todo-capture-dir (expand-file-name "project-org-todo-capture" rgr/emacs-project-dir ))
(setq load-path (cons (expand-file-name "project-org-todo-capture" rgr/emacs-project-dir ) load-path))
(use-package project-org-todo-capture
  :ensure nil
  :bind (:map project-prefix-map
              (("t" . project-org-todo-capture)
              ("T" . project-org-todo-capture-file-open))))

toggle buffer

(defun rgr/toggle-buffer(n)
  "jump to or from buffer named n else default to *Messages*"
  (interactive "bbuffer:")
  (let ((n (or n
               "*Messages*")))
    (switch-to-buffer (if (string= (buffer-name) n)
                          (other-buffer) n))))

read and write elisp vars to file

(defun rgr/elisp-write-var (f v)
  (with-temp-file f
    (prin1 v (current-buffer))))

(defun rgr/elisp-read-var (f)
  (with-temp-buffer
    (insert-file-contents f)
    (cl-assert (eq (point) (point-min)))
    (read (current-buffer))))

completing lines

(defvar rgr/complete-line-f 'rgr/newline-below "The fname called by `rgr/complete-line'")

(defun rgr/complete-line()
  (interactive)
  (funcall rgr/complete-line-f))

(defun rgr/c-complete-line()
  (end-of-line)
  (delete-trailing-whitespace)
  (unless (eql ?\; (char-before (point-at-eol)))
    (insert ";"))
  (newline-and-indent))

(defun rgr/insert-previous-line()
  (previous-line)
  (end-of-line)
  (newline-and-indent)
  (insert (string-trim (current-kill 0))))

(defun rgr/newline-below()
  (end-of-line)
  (newline-and-indent))


(global-set-key (kbd "C-S-<return>")  'rgr/complete-line)

Lazy Language Learning, lazy-lang-learn

My own hack for popping up text to learn

(setq lazyll-dir (expand-file-name "lazy-lang-learn" rgr/emacs-project-dir ))
(setq load-path (cons (expand-file-name "lazy-lang-learn" rgr/emacs-project-dir ) load-path))
(use-package lazy-lang-learn
  :ensure  nil
  :bind
  ("C-c L" . lazy-lang-learn-mode)
  ("<f12>" . lazy-lang-learn-translate)
  ("S-<f12>" . lazy-lang-learn-translate-from-history))

** Minibuffer Enrichment (search, sudo edit…) :minibuffer:

Various plugins for minibuffer enrichment

sudo-edit Priviliged file editing

(use-package sudo-edit)

find file at point

(use-package ffap
  :ensure nil
  :custom
  (ffap-require-prefix nil)
  :init
  (ffap-bindings)
  (defun rgr/ffap()
    (interactive)
    (let ((url (ffap-url-at-point)))
      (if (and url current-prefix-arg)
          (progn
            (notifications-notify
             :title "Emacs"
             :body "opening url in generic browser")
            (browse-url-generic url))
        (call-interactively 'find-file-at-point))))
  :bind
  ( "C-x C-f" . rgr/ffap))

Consult

Consult Core

Consult]] Provides various commands based on the Emacs completion function completing-read

;; Example configuration for Consult
;; Example configuration for Consult
(use-package consult
  ;; Replace bindings. Lazily loaded by `use-package'.
  :bind (;; C-c bindings in `mode-specific-map'
         ("C-c M-x" . consult-mode-command)
         ("C-c h" . consult-history)
         ("C-c k" . consult-kmacro)
         ("C-c m" . consult-man)
         ("C-c i" . consult-info)
         ([remap Info-search] . consult-info)
         ;; C-x bindings in `ctl-x-map'
         ("C-x M-:" . consult-complex-command)     ;; orig. repeat-complex-command
         ("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 t b" . consult-buffer-other-tab)    ;; orig. switch-to-buffer-other-tab
         ("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
         ;; M-g bindings in `goto-map'
         ("M-g e" . consult-compile-error)
         ("M-g f" . consult-flymake)               ;; Alternative: consult-flymake
         ("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 in `search-map'
         ("M-s d" . consult-find)                  ;; Alternative: consult-fd
         ("M-s c" . 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 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 "M-.")
  ;; (setq consult-preview-key '("S-<down>" "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-file-register
   consult--source-recent-file consult--source-project-recent-file
   ;; :preview-key "M-."
   :preview-key '(:debounce 0.4 any))

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

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

consult-omni

(use-package consult-omni
  :disabled t ;; https://github.com/armindarvish/consult-omni/issues/47
      :ensure  (:host github :repo "armindarvish/consult-omni" :files (:defaults "sources/*.el"))
      :after consult)

Marginalia margin annotations for info on line

are marks or annotations placed at the margin of the page of a book or in this case helpful colorful annotations placed at the margin of the minibuffer for your completion candidates

;; Enable rich annotations using the Marginalia package
(use-package marginalia
  ;; Bind `marginalia-cycle' locally in the minibuffer.  To make the binding
  ;; available in the *Completions* buffer, add it to the
  ;; `completion-list-mode-map'.
  :bind (:map minibuffer-local-map
         ("M-m" . marginalia-cycle))

  ;; The :init section is always executed.
  :init
  ;; Marginalia must be activated in the :init section of use-package such that
  ;; the mode gets enabled right away. Note that this forces loading the
  ;; package.
  (marginalia-mode))

embark

(use-package embark
  :ensure t

  :bind
  (("C-." . embark-act)         ;; pick some comfortable binding
   ("C-:" . embark-act-all)
   ("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)

  ;; Show the Embark target at point via Eldoc. You may adjust the
  ;; Eldoc strategy, if you want to see the documentation from
  ;; multiple providers. Beware that using this can be a little
  ;; jarring since the message shown in the minibuffer can be more
  ;; than one line, causing the modeline to move up and down:

  ;; (add-hook 'eldoc-documentation-functions #'embark-eldoc-first-target)
  ;; (setq eldoc-documentation-strategy #'eldoc-documentation-compose-eagerly)

  :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
  :demand t ; only need to install it, embark loads it after consult if found
  :hook
  (embark-collect-mode . consult-preview-at-point-mode))

all-the-icons

Remember to run all-the-icons-install-fonts.

(use-package all-the-icons
  :demand
  :after (marginalia)
  :config
  (use-package all-the-icons-completion
    :init (all-the-icons-completion-mode))
  (use-package all-the-icons-dired
    :config
    (add-hook 'dired-mode-hook 'all-the-icons-dired-mode))
  :hook (marginalia-mode . all-the-icons-completion-marginalia-setup))

Completion

Let emacs suggest completions

*** corfu

(use-package corfu
  ;;:disabled t
  ;; Optional customizations
  :custom
  ;; (corfu-cycle t)                ;; Enable cycling for `corfu-next/previous'
  (corfu-auto t)                 ;; Enable auto completion
  ;;(corfu-quit-at-boundary nil)   ;; Never quit at completion boundary
  (corfu-quit-no-match t)      ;; Never quit, even if there is no match
  (corfu-popupinfo-delay (cons nil 1.0))
  (corfu-preview-current t)    ;; Disable current candidate preview
  ;; (corfu-preselect 'prompt)      ;; Preselect the prompt
  ;; (corfu-on-exact-match nil)     ;; Configure handling of exact matches

  ;; Enable Corfu only for certain modes. See also `global-corfu-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 the customization variable
  ;; `global-corfu-modes' to exclude certain modes.
  ;; A few more useful configurations...
  ;;TAB cycle if there are only few candidates
  ;; (completion-cycle-threshold 3)

  ;; Enable indentation+completion using the TAB key.
  ;; `completion-at-point' is often bound to M-TAB.
  (tab-always-indent 'complete)

  ;; Emacs 30 and newer: Disable Ispell completion function.
  ;; Try `cape-dict' as an alternative.
  (text-mode-ispell-word-completion nil)

  ;; Hide commands in M-x which do not apply to the current mode.  Corfu
  ;; commands are hidden, since they are not used via M-x. This setting is
  ;; useful beyond Corfu.
  (read-extended-command-predicate #'command-completion-default-include-p)
:config
(add-hook 'eglot-stay-out-of 'company)
(use-package orderless
  :custom
  (orderless-component-separator " +\\|[-/]")
  (completion-styles '(orderless basic))
  (completion-category-defaults nil)
  (completion-category-overrides '((file (styles partial-completion)))))
:init
(global-corfu-mode)
(corfu-popupinfo-mode))

;; Optionally use the `orderless' completion style.
(use-package orderless
  :custom
  ;; (orderless-style-dispatchers '(orderless-affix-dispatch))
  ;; (orderless-component-separator #'orderless-escapable-split-on-space)
  (completion-styles '(orderless basic))
  (completion-category-defaults nil)
  (completion-category-overrides '((file (styles partial-completion)))))


;; Use Dabbrev with Corfu!
(use-package dabbrev
  :ensure nil
  ;; Swap M-/ and C-M-/
  :bind (("M-/" . dabbrev-completion)
         ("C-M-/" . dabbrev-expand))
  :config
  (add-to-list 'dabbrev-ignored-buffer-regexps "\\` ")
  ;; Since 29.1, use `dabbrev-ignored-buffer-regexps' on older.
  (add-to-list 'dabbrev-ignored-buffer-modes 'doc-view-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'pdf-view-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'tags-table-mode))

;; Add extensions
(use-package cape
  ;; Bind prefix keymap providing all Cape commands under a mnemonic key.
  ;; Press C-c p ? to for help.
  :bind ("C-c p" . cape-prefix-map) ;; Alternative keys: M-p, M-+, ...
  ;; Alternatively bind Cape commands individually.
  ;; :bind (("C-c p d" . cape-dabbrev)
  ;;        ("C-c p h" . cape-history)
  ;;        ("C-c p f" . cape-file)
  ;;        ...)
  :init
  ;; Add to the global default value of `completion-at-point-functions' which is
  ;; used by `completion-at-point'.  The order of the functions matters, the
  ;; first function returning a result wins.  Note that the list of buffer-local
  ;; completion functions takes precedence over the global list.
  (add-hook 'completion-at-point-functions #'cape-dabbrev)
  (add-hook 'completion-at-point-functions #'cape-file)
  (add-hook 'completion-at-point-functions #'cape-elisp-block)
  ;; (add-hook 'completion-at-point-functions #'cape-history)
  ;; ...
  )

*** Which Key :which🔑

which-key shows you what further key options you have if you pause on a multi key command.
(use-package  which-key
  :ensure nil
  :demand t
  :config (which-key-mode))

*** Yasnippet :yasnippet: YASnippet is a template system for Emacs. Note that eglot 1.4 auto enables snippets so no need to yas-minor or global mode

(use-package yasnippet
  :config
  (use-package yasnippet-snippets)
  :init
  (yas-global-mode)
  )

*** Abbrev Mode

Abbrev Mode is very useful for expanding small text snippets
(setq-default abbrev-mode 1)
;;  (load-file abbrev-file-name)
(defadvice expand-abbrev (after my-expand-abbrev activate)
  ;; if there was an expansion
  (if ad-return-value
      ;; start idle timer to ensure insertion of abbrev activator
      ;; character (e.g. space) is finished
      (run-with-idle-timer 0 nil
                           (lambda ()
                             ;; if there is the string "%CHANGEME%" in the
                             ;; expansion then move cursor there and
                             ;; delete the string
                             (let ((cursor "%CHANGEME%"))
                               (when (search-backward  cursor last-abbrev-location t)
                                 (goto-char  last-abbrev-location)
                                 (search-forward cursor)
                                 (backward-word)
                                 (highlight-symbol-at-point)
                                 (delete-char (length cursor))
                                 ))))))

*** company

(use-package company
  :disabled t
  :config
  (use-package company-box
    :config
    (setf (alist-get 'internal-border-width company-box-doc-frame-parameters) 1)
    :hook (company-mode . company-box-mode))
  :hook
  (prog-mode . company-mode)
  :bind( :map company-mode-map
         ("<tab>" .  company-indent-or-complete-common)))

*** vertical interactive completion https://github.com/minad/vertico

;; Enable vertico
(use-package vertico
  ;;:disabled
  :custom
  (vertico-cycle t)
  :config
  (vertico-mode))

** Org functionality

General org-mode config

Org Mode, org-mode

  (use-package org
    :custom
;;    (org-agenda-files (append (directory-files-recursively "~/.emacs.d/var/org/orgfiles" "^[[:alnum:]].*\\.org\\'") (directory-files-recursively "~/development/projects" "^[[:alnum:]].*\\.org\\'")))
    (org-fontify-done-headline t)
    (org-fontify-todo-headline t)
    (org-clock-idle-time 10)
    (org-babel-default-header-args:python
     '((:results  . "output")))
    (org-export-with-broken-links t)
    (org-refile-use-outline-path 'file)
    (org-outline-path-complete-in-steps nil)
    :config
    (set-face-attribute 'org-headline-done nil :strike-through t)
    (defun rgr/org-agenda (&optional arg)
      (interactive "P")
      (let ((org-agenda-tag-filter-preset '("-trash")))
        (org-agenda arg "a")))
    :bind
    ("C-c a" . org-agenda)
    ("C-c A" . rgr/org-agenda)
    ("C-c c" . org-capture)
    ("C-c l" . org-store-link)
    ("C-c C-l" . org-insert-link)
    ("C-c C-s" . org-schedule)
    ("C-c C-t" . org-todo)
    ("C-c C-x C-j" . org-clock-goto)
    (:map org-mode-map
          ("M-." . find-function-at-point)))

org-contrib

;;(use-package org-contrib)

org-id

create unique link IDs when sharing a link to an org section
;;(require 'org-id)

crypt

(require 'org-crypt)
(org-crypt-use-before-save-magic)

async babel blocks

(use-package ob-async)

org agenda files

See org-agenda-files org-agenda-files maintain a file pointing to agenda sources : NOTE, NOT tangled. ((no-littering-expand-etc-file-name “org/agenda-files.txt”))
~/.emacs.d/var/org/orgfiles
~/.emacs.d/var/org/orgfiles/journals
~/.emacs.d/var/org/orgfiles/projects
~/development/education/lessons
~/development/education/lessons/bash
~/development/education/lessons/python
~/development/education/lessons/python/coreyschafer
~/development/education/lessons/python/python-lernen.de
~/development/education/lessons/elisp

Typesetting

Need to install dvipng, texlive, texlive-latex-extra

auctex

  (use-package auctex
    :disabled t
    :init
    (require 'ox-latex)
    ;;(use-package lsp-latex)
    :custom
    (TeX-auto-save t)
    (TeX-parse-self t)
    (TeX-master nil)
    (TeX-PDF-mode t)
;;    (org-preview-latex-default-process 'dvipng)
    :config
    (defun rgr/latex-mode-hook()
      ;; buggy as this then gets savd to the global abbrevs
      (load-file (expand-file-name  "etc/abbrev/latex-songbook-chords.el" user-emacs-directory ))
      (setq abbrevs-changed nil)
      (turn-on-reftex)
      (visual-line-mode)
      (LaTeX-math-mode)
      (flyspell-mode))

    :hook
    (TeX-mode .
              (lambda () (rgr/latex-mode-hook)(TeX-fold-mode 1)))); Automatically activate TeX-fold-mode.

lilypond

https://lilypond.org/doc/v2.23/Documentation/usage/text-editor-support

(use-package
  lilypond
  :disabled)

example

Chorded

Reference/Lookup/Media

lookup and reference uilities and config

chatgpt

GPTel

https://github.com/karthink/gptel

(use-package gptel
  :bind
  ("C-c q" . #'gptel-send))
secret openAPI key

-----BEGIN PGP MESSAGE-----

hQEMA7IjL5SkHG4iAQf+N61j3/62smGNrhRPOrE3U8JMpJlcDf7d0gukqvXXYD3r A0t7kLn3T4t0zfwDq/TvXRXhdB+IMkkB5vK+A4HGQv9jPuVGzoalYvzGlJpSGw2O /Q6EHYmtms31r71LCFYMDg+8FsVFN+l43QRCOeFmJNv+paEbB0xH9xzrpaIqUQV3 LwBrriEfRo0PPwq3164HT/cjdzGLGLchSsBbfbXfAzN/JnN2olaHxiz+6kL+IWvZ kI9IRBhOFnPigbQ+QXzni0JimSavFE/qTaPpiFIh+PUp8ETt2TcjarzrpLetk8lA fIhRyWuu3+GTDuc5iASXGcGKHMusNE+xC20FNcwWDdKbAd2N2BRg2gwO/jzlm7Gc l8/YEKMfbaubRX/hG2qOV8OnS+Io8cZx9cN3L7X6QbCzkW0KPwMt2O+CNYvKADFU F4czehuTpGF0+QVLOpzgvOzPHZdbtiFiH47PdN/rXlHpwAX0cqhpe8WPAYBzNd22 DvWoHsRLGhCVC8YTZrhVs48WbzJxHKBEnoswqlEk4534cIiL7NbwhlJPWg8= =UHS1 -----END PGP MESSAGE-----

Ellama

https://github.com/s-kostyaev/ellama https://github.com/s-kostyaev/ellama https://ollama.ai/library/zephyr

(use-package ellama
  :custom
  (ellama-sessions-directory (expand-file-name  "var/ellama-sessions/" user-emacs-directory))
  :init
  (setopt ellama-language "German")
  (require 'llm-ollama))

web lookup/view

eww

(use-package eww
  :ensure nil
  :demand t
  :init
  ;; (add-to-list 'display-buffer-alist  '((or (major-mode . eww-mode)(major-mode . Info-mode)(major-mode . helpful-mode)) (display-buffer-reuse-mode-window display-buffer-in-side-window) (window-sides-vertical . t)(side . right)(slot . -1) (window-width . 0.5)) )
  (add-to-list 'display-buffer-alist  '((or (major-mode . eww-mode)(major-mode . Info-mode)(major-mode . helpful-mode)(major-mode . help-mode)) (display-buffer-in-direction) (direction . right)(window-width . 0.5)) )
  :config
  ;; Advice EWW to launch certain URLs using the generic launcher rather than EWW.
  (defcustom rgr/eww-external-launch-url-chunks '("youtube")
    "If any component of this list is contained in an EWW url then it will use `browse-url-generic to launch that url instead of `eww"
    :type '(repeat string))
  (defadvice eww (around rgr/eww-extern-advise activate)
    "Use `browse-url-generic if any part of URL is contained in `rgr/eww-external-launch-url-chunks"
    (if (string-match-p (regexp-opt rgr/eww-external-launch-url-chunks) url)
        (progn
          (call-process-shell-command "swaymsg workspace number 2" nil 0)
          (browse-url-generic url))
      ad-do-it))
  (defun rgr/eww-after-render ()
    ;;move point line to top
    (condition-case err
        (dotimes (_ 2)
          (recenter-top-bottom))
      (error nil)))
  (defun rgr/eww-launch-external-browser-from-buffer()
    (interactive)
    (emacs-alert "Launching external browser")
    (call-process-shell-command "swaymsg workspace number 2" nil 0)
    (eww-browse-with-external-browser)
    (quit-window))
  :custom
  (eww-history-limit 256)
  :hook (eww-after-render . rgr/eww-after-render)
  :bind
  (:map eww-mode-map
        ( "&" . rgr/eww-launch-external-browser-from-buffer)))

go-translate

This is a translation framework for emacs, and is flexible and powerful.

(use-package go-translate
  ;;:disabled
  :custom
  (gts-translate-list '(("en" "de")))
  (gts-default-translator
   (gts-translator
    :picker (gts-prompt-picker)
    :engines (list (gts-bing-engine) (gts-google-engine))
    :render (gts-buffer-render)))
  :bind
  ("C-c T" . gts-do-translate))
Google translate
(use-package google-translate
  :disabled ;; use go-translate
  :init
  (require 'google-translate)

  :custom
  (google-translate-backend-method 'curl)
  (google-translate-pop-up-buffer-set-focus t)
  :config

  (defun google-translate--search-tkk () "Search TKK." (list 430675 2721866130))

  (defun google-translate-swap-default-languages()
    "swap google-translate default languages"
    (setq google-translate-default-source-language  (prog1 google-translate-default-target-language (setq google-translate-default-target-language  google-translate-default-source-language))))

  (defun rgr/google-translate-in-history-buffer(&optional phrase)
    (interactive)
    (when current-prefix-arg
      ;;swap source and dest languages
      (google-translate-swap-default-languages))
    (let  ((phrase (if phrase phrase (rgr/thing-at-point-dwim))))
      (switch-to-buffer "*Google Translations*")
      ;; need to make aminor mode and do this properly based on file - org-mode?
      (local-set-key (kbd "<return>") (lambda() (interactive)
                                        (goto-char(point-max))
                                        (newline)))
      (unless (= (current-column) 0)
        (end-of-line)
        (newline))
      (insert  (format "<%s>: %s" (format-time-string "%Y-%m-%d %T") phrase))
      (rgr/google-translate-at-point)))

  (defun rgr/google-translate-at-point()
    "reverse translate word/region if prefix"
    (interactive)
    (when current-prefix-arg
      ;;swap source and dest languages
      (google-translate-swap-default-languages))
    (google-translate-at-point)
    (if google-translate-pop-up-buffer-set-focus
        (select-window (display-buffer "*Google Translate*"))))

  (defun rgr/google-translate-query-translate()
    "reverse translate input if prefix"
    (interactive)
    (when current-prefix-arg
      ;;swap source and dest languages
      (google-translate-swap-default-languages))
    (google-translate-query-translate)
    (if google-translate-pop-up-buffer-set-focus
        (select-window (display-buffer "*Google Translate*"))))

  :bind
  ("C-c T" . rgr/google-translate-at-point)
  ("C-c t" . rgr/google-translate-query-translate)
  ("C-c b" . rgr/google-translate-in-history-buffer))

utility funcs

A bit of a dogs dinner.

use browser for docs

(defcustom rgr/browser-doc-url "https://www.google.com/search?q=%s" "format url variable used for function `rgr/browser-doc-search'")
(defun rgr/browser-doc-search(&optional sym)
  "call function `browse-url' with a url variable `rgr/browser-doc-url' formatted with variable `sym'"
  (interactive
   (list
    (let((sym (replace-regexp-in-string  "^\\." "" (kill-dwim) )))
      (read-string (format "search(%s):" sym)
                   nil nil sym))))
  (browse-url (format rgr/browser-doc-url sym)))

Dictionary,Thesaurus

The more emacsy Dictionary .
(use-package
  dictionary
  :commands (rgr/dictionary-search)
  :custom
  (dictionary-server "dict.org")
  ;;(dictionary-server "localhost")
  :config
  (use-package mw-thesaurus)
  (defun rgr/dictionary-search(&optional w)
    (interactive)
    (dictionary-search (if w w (rgr/thing-at-point-dwim))))
  :bind
  ("<f6>" . rgr/dictionary-search)
  ("S-<f6>" . mw-thesaurus-lookup-dwim))

GoldenDict - external lookup and reference

When using goldendict-dwim why not add your program to the wonderful GoldenDict? A call to trans-shell in the dictionary programs tab gives us google translate:-

trans -e google -s de -t en -show-original y -show-original-phonetics n -show-translation y -no-ansi -show-translation-phonetics n -show-prompt-message n -show-languages y -show-original-dictionary n -show-dictionary n -show-alternatives n "%GDWORD%"
(use-package
  goldendict
  :disabled t
  :commands (goldendict-dwim)
  :config
  (defun goldendict-dwim
      (&optional
       w)
    "lookup word at region, thing at point or prompt for something, in goldendict. Use a prefix to force prompting."
    (interactive)
    (let ((w (if w w (rgr/thing-at-point-dwim))))
      (call-process-shell-command (format  "goldendict \"%s\"" w ) nil 0)))
  :bind (("C-x G" . goldendict-dwim)))

API docs

(defun rgr/devdocs()
  "If in an emacs-lisp buffer or bable block use `rgr/elisp-lookup-reference' else devdocs."
  (interactive)
  (if (or (derived-mode-p  'emacs-lisp-mode) (and (eq
                                                   major-mode 'org-mode) (string= "emacs-lisp" (car (org-babel-get-src-block-info)))))
      (rgr/emacs-lisp-help)
    (let ((s (symbol-at-point)))
      (message "symbol-at-point: %s" s)
      (if (fboundp 'devdocs-browser-open)
          (devdocs-browser-open)
        (call-interactively 'devdocs-lookup (vector 't s ))))))
(global-set-key (kbd "C-q")  'rgr/devdocs)

devdocs-browser

https://github.com/blahgeek/emacs-devdocs-browser :

Browse devdocs.io documents inside Emacs!

(use-package devdocs-browser
  ;;:disabled t
  :custom
  (devdocs-data-dir (expand-file-name  "var/devdocs-browser" user-emacs-directory))
  (devdocs-browser-cache-directory (expand-file-name  "var/devdocs-browser/cache" user-emacs-directory))
  (devdocs-browser-data-directory (expand-file-name  "var/devdocs-browser/data" user-emacs-directory))
  :hook
  (c-ts-mode . (lambda()(setq-local devdocs-browser-active-docs '("c"))))
  (c++-ts-mode . (lambda()(setq-local devdocs-browser-active-docs '("cpp")))))

devdocs

https://github.com/astoff/devdocs.el

Browse devdocs.io documents inside Emacs!

(use-package devdocs
  :disabled t
  :hook
  (c-ts-mode . (lambda()(setq-local devdocs-current-docs '("c"))))
  (c++-ts-mode . (lambda()(setq-local devdocs-current-docs '("cpp")))))

Elfeed

Elfeed is an extensible web feed reader for Emacs, supporting both Atom and RSS.
(use-package elfeed
  :config
  (use-package elfeed-org
    :custom
    (rmh-elfeed-org-files (list (expand-file-name  "elfeed/elfeed.org" user-emacs-directory )))
    :config
    (elfeed-org))
  (run-at-time nil (* 8 60 60) #'elfeed-update)
  :bind
  ( "C-c w" . elfeed)
  (:map elfeed-show-mode-map
        ("b" . (lambda()(call-process-shell-command "swaymsg workspace number 2" nil 0)(interactive)(elfeed-show-visit t))))
  (:map elfeed-search-mode-map
        ("b" . (lambda()(call-process-shell-command "swaymsg workspace number 2" nil 0)(interactive)(elfeed-search-browse-url t)))))

elfeed-org

pdf-tools

pdf-tools is, among other things, a replacement of DocView for PDF files
(use-package pdf-tools
  :after (org-plus-contrib)
  :config
  (pdf-tools-install)
  (add-hook 'pdf-isearch-minor-mode-hook (lambda () ;; (ctrlf-local-mode -1)
                                           ))
  (use-package org-pdftools
    :hook (org-mode . org-pdftools-setup-link)))

requirements

sudo apt install libpng-dev zlib1g-dev libpoppler-glib-dev libpoppler-private-dev imagemagick

impatient-showdow, markdown view live

Preview markdown buffer live over HTTP using showdown. https://github.com/jcs-elpa/impatient-showdown

(use-package impatient-showdown
  :disabled
  :hook (markdown-mode . impatient-showdown-mode))

Shells and Terminals

lookup and reference uilities and config

*** VTERM

(use-package vterm)
(use-package  multi-vterm
  :after vterm
  :init
  (add-to-list 'display-buffer-alist  '((or (major-mode . vterm-mode))
                                        (display-buffer-reuse-mode-window
                                         display-buffer-in-direction)
                                        (direction . below)
                                        (window-height . 0.3)))
  :bind
  ("M-g t" . multi-vterm-project))

** Email

*** notmuch

(use-package notmuch
  :init
  (defun rgr/notmuch-new()
    (message "refreshing notmuch")
    (call-process-shell-command "notmuch new" nil 0))
  :hook
  (notmuch-hello-mode . rgr/notmuch-new)
  )

*** mu4e 📧mu4e:

(use-package mu4e :ensure ( :host github
                            :branch "release/1.10"
                            :repo "djcb/mu"
                            :files ("mu4e/*.el" "build/mu4e/mu4e-meta.el" "build/mu4e/mu4e-config.el" "build/mu4e/mu4e.info")
                            :main "mu4e/mu4e.el"
                            :pre-build (("./autogen.sh")
                                        ("ninja" "-C" "build")
                                        (make-symbolic-link (expand-file-name "./build/mu/mu")
                                                            (expand-file-name "~/bin/mu") 'ok-if-exists)))
  :commands (mu4e mu4e-update-index)
  :custom
  ( mayil-user-agent 'mu4e-user-agent )
  ( mail-user-agent 'mu4e-user-agent )
  ( message-send-mail-function 'smtpmail-send-it )
  ( mu4e-attachment-dir "~/Downloads" )
  ( mu4e-change-filenames-when-moving t )
  ( mu4e-compose-context-policy 'ask )
  ( mu4e-confirm-quit nil )
  ( mu4e-context-policy 'pick-first )
  ( mu4e-compose-reply-recipients 'sender )
  ( mu4e-headers-include-related nil )
  ( mu4e-headers-show-threads nil ) ; Use "P" to toggle threading
  ( mu4e-decryption-policy 'ask )
  ( mu4e-hide-index-messages t )
  ( mu4e-mu-binary (expand-file-name "mu/build/mu/mu" elpaca-repos-directory) )
  ( mu4e-update-interval nil )
  ( mu4e-use-fancy-chars t )
  ( mu4e-view-prefer-html nil )
  ( mu4e-view-show-addresses t )
  ( smtpmail-smtp-service 587 )
  ( user-full-name "Richard G.Riley" )
  :config

  (use-package mu4e-alert
    :init
    (add-hook 'after-init-hook #'mu4e-alert-enable-mode-line-display))

  (use-package mu4e-column-faces
    :after mu4e
    :config (mu4e-column-faces-mode))

  (setq mu4e-contexts
        `( ,(make-mu4e-context
             :name "aGmx"
             :enter-func (lambda () (mu4e-message "gmx context")(rgr/mu4e-refresh))
             :match-func (lambda (msg)
                           (when msg
                             (string-match-p "^/gmx" (mu4e-message-field msg :maildir))))
             :vars '( ( user-mail-address . "[email protected]" )
                      ( user-full-name . "Richard G. Riley" )
                      ( smtpmail-smtp-server . "mail.gmx.net")
                      ( mu4e-get-mail-command . "getmails gmx gmx-special-interest")
                      ( mu4e-refile-folder . "/gmx/Archive" )
                      ( mu4e-sent-folder . "/gmx/Sent" )
                      ( mu4e-sent-messages-behavior . sent)
                      ( mu4e-trash-folder . "/gmx/Bin" )
                      ( mu4e-drafts-folder . "/gmx/Drafts" )
                      ;; (mu4e-maildir-shortcuts .
                      ;;  (("/gmx/INBOX"             . ?i)
                      ;;    ("/gmx/Sent" . ?s)
                      ;;    ("/gmx/Bin"     . ?b)
                      ;;    ("/gmx/Drafts"    . ?d)
                      ;;    ("/gmx/Spam"    . ?p)
                      ;;    ("/gmx/Archive"  . ?a)))
                      ( mu4e-bookmarks . ((:name "Inbox" :query "maildir:/gmx/INBOX and flag:unread" :key ?i)
                                          (:name "Learning" :query "maildir:/gmx/Learning* and flag:unread" :key ?l)
                                          (:name "All Today's messages" :query "maildir:/gmx/*  AND NOT (maildir:/gmx/Spam  OR  maildir:/gmx/Sent) AND date:today..now " :key ?t)
                                          (:name "Last 7 days" :query "maildir:/gmx/* AND NOT (maildir:/gmx/Spam  OR  maildir:/gmx/Sent)  AND date:7d..now" :hide-unread t :key ?w)
                                          (:name "All" :query "maildir:/gmx/* and not (maildir:/gmx/Spam or maildir:/gmx/Bin)" :key ?a)
                                          (:name "Bin" :query "maildir:/gmx/Bin" :key ?b)
                                          ;;                      (:name "Messages with images" :query "maildir:/gmx/* AND  NOT maildir:/gmx/Spam  AND  NOT maildir:/gmx/Sent" :key ?m)
                                          (:name "Spam" :query "maildir:/gmx/Spam AND date:7d..now" :hide-unread t :key ?p)))
                      ( mu4e-compose-signature  .
                        (concat
                         "Richard G. Riley\n"
                         "Ein bier, ein Helbing.\n"))))
           ,(make-mu4e-context
             :name "bGmail"
             :enter-func (lambda () (mu4e-message "gmail context") (rgr/mu4e-refresh))
             ;; no leave-func
             ;; we match based on the maildir of the message
             ;; this matches maildir /Arkham and its sub-directories
             :match-func (lambda (msg)
                           (when msg
                             (string-match-p "^/gmail" (mu4e-message-field msg :maildir))))
             :vars '( ( user-mail-address . "[email protected]"  )
                      ( user-full-name . "Richie" )
                      ( smtpmail-smtp-server . "smtp.gmail.com")
                      ( mu4e-get-mail-command . "getmails gmail")
                      ( mu4e-refile-folder . "/gmail/Archive" )
                      ( mu4e-sent-folder . "/gmail/Sent" )
                      ( mu4e-sent-messages-behavior . delete)
                      ( mu4e-trash-folder . "/gmail/Bin" )
                      ( mu4e-drafts-folder . "/gmail/Drafts" )
                      ;; (mu4e-maildir-shortcuts .
                      ;;   (("/gmail/INBOX"             . ?i)
                      ;;    ("/gmail/Sent" . ?s)
                      ;;    ("/gmail/Bin"     . ?b)
                      ;;    ("/gmail/Drafts"    . ?d)
                      ;;    ("/gmail/Spam"    . ?p)
                      ;;    ("/gmail/Archive"  . ?a)))
                      ( mu4e-bookmarks . ((:name "Inbox" :query "maildir:/gmail/INBOX and flag:unread" :key ?i)
                                          (:name "All Today's messages" :query "maildir:/gmail/* AND NOT (maildir:/gmail/Spam  OR  maildir:/gmail/Sent) AND date:today..now " :key ?t)
                                          (:name "Last 7 days" :query "maildir:/gmail/* AND NOT (maildir:/gmail/Spam  OR  maildir:/gmail/Sent) AND date:7d..now" :hide-unread t :key ?w)
                                          (:name "All" :query "maildir:/gmail/* and not (maildir:/gmail/Spam or maildir:/gmail/Bin)" :key ?a)
                                          (:name "Bin" :query "maildir:/gmail/Bin" :key ?b)
                                          ;;                    (:name "Messages with images" :query "maildir:/gmail/* AND  NOT maildir:/gmail/Spam  AND  NOT maildir:/gmail/Sent" :key ?m)
                                          (:name "Spam" :query "maildir:/gmail/Spam AND date:7d..now" :hide-unread t :key ?p)))
                      ( mu4e-compose-signature . "Please change my email to '[email protected]'.")))))

  (defun mu4e-smarter-compose ()
    "My settings for message composition."
    (set-fill-column 72)
    (flyspell-mode))

  (defun rgr/mu4e-refresh()
    (interactive)
    (emacs-alert "refreshing mu4e indexes")
    (call-interactively #'(lambda () (interactive)(mu4e-update-mail-and-index t))))

  (defun rgr/mu4e-default-context()
    (interactive)
    (mu4e)
    (mu4e-context-switch nil "bGmail"))

  (add-to-list 'mu4e-view-actions
               '("ViewInBrowser" . mu4e-action-view-in-browser) t)
  (add-to-list 'mu4e-view-actions
               '("XWidget View" . mu4e-action-view-with-xwidget) t)
  (add-to-list 'mu4e-view-actions
               '("Markall as read" . mu4e-headers-mark-all-unread-read) t)
  (require 'mu4e-contrib)
  :hook ((mu4e-view-rendered . visual-line-mode)
         (mu4e-compose-mode . mu4e-smarter-compose)
         (mu4e-view-rendered .
                             (lambda()
                               ;; try to emulate some of the eww key-bindings
                               (local-set-key (kbd "<tab>") 'shr-next-link)
                               (local-set-key (kbd "<backtab>") 'shr-previous-link))))
  :bind	  (("C-c u" .  rgr/mu4e-default-context)
           (:map mu4e-main-mode-map
                 ("m" . mu4e-compose-new))
           (:map mu4e-main-mode-map
                 ("g" . rgr/mu4e-refresh))
           (:map mu4e-headers-mode-map
                 ("v" . mu4e-view-action)
                 ("C-c u" . mu4e-headers-mark-all-unread-read))))
;;:map mu4e-view-mode-map
;;   ("V" . '(lambda()(message "%s" (mu4e-message-at-point))))))) ;; mu4e-action-view-in-browser))))

Programming Language related

tag matching

(use-package evil-matchit
  :bind
  ("M-(" . evilmi-jump-items-native))

consult xref stack

(use-package consult-xref-stack :ensure (:host github :repo "brett-lempereur/consult-xref-stack")
:bind
(("C-," . consult-xref-stack-backward)))

rmsbolt

RMSbolt is a compiler output viewer in Emacs. https://github.com/emacsmirror/rmsbolt

(use-package rmsbolt
  :demand t
  :init
  (defun rgr/rmsbolt()
    (interactive)
    (if (not rmsbolt-mode)
        (rmsbolt)
      (progn
        (rmsbolt-mode -1)
        (when (get-buffer rmsbolt-output-buffer)
            (with-current-buffer  rmsbolt-output-buffer
              (kill-buffer-and-window))))))
  :bind
  (:map prog-mode-map
        ("C-c d" . rgr/rmsbolt)))

parrot

(use-package parrot
  :config
  (defun my/parrot-animate-when-compile-success (buffer result)
    (if (string-match "^finished" result)
        (parrot-start-animation)))    (parrot-mode)
  (add-to-list 'compilation-finish-functions 'my/parrot-animate-when-compile-success))

eldoc

(use-package eldoc
  :custom
  (eldoc-idle-delay 1)
  (eldoc-echo-area-use-multiline-p t)
  :config
  (defun rgr/eldoc-mode-hook()
    ;;(eldoc-box-hover-at-point-mode)
    )
  :config
  (global-eldoc-mode)
  :hook
  (eldoc-mode . rgr/eldoc-mode-hook)
  :bind
  ("C-h p" . eldoc-box-help-at-point))
(use-package eldoc-box
  :after eldoc)

compilation

(global-set-key (kbd "C-c C-r") 'recompile)
(global-set-key (kbd "<f9>")
  '(lambda () (interactive)
      (condition-case nil (next-error)
         (error (next-error 1 t)))))

indent bars

(use-package indent-bars
  :disabled
  :ensure t
  :straight (indent-bars :type git :host github :repo "jdtsmith/indent-bars")
  :hook
  (prog-mode . indent-bars-mode))

JSON

(use-package json-mode)
(use-package jsonrpc)

Treemacs

(use-package
  treemacs
  :init
  (add-to-list 'image-types 'svg)
  :custom
  (treemacs-follow-after-init t) ; hello
  :config
  (treemacs-follow-mode +1)
  (treemacs-fringe-indicator-mode)
  (treemacs-git-mode 'deferred)
  :bind
  ("M-9"   . 'treemacs-select-window)
  (:map treemacs-mode-map
        ("<right>" . treemacs-peek)))
(use-package treemacs-magit
  :after treemacs)

duplicate thing

(use-package duplicate-thing
  :bind
  ("C-S-d" . 'duplicate-thing))

Breadcrumbs

(use-package breadcrumb
  :config
  (breadcrumb-mode))

prog-mode hack

(unless (fboundp 'prog-mode)
  (defalias 'prog-mode 'fundamental-mode))

Show Line numbers

(global-set-key (kbd "S-<f2>") 'display-line-numbers-mode)
(add-hook 'prog-mode-hook (lambda() (display-line-numbers-mode t)))

code format

;; auto-format different source code files extremely intelligently
;; https://github.com/radian-software/apheleia
(use-package apheleia
  :disabled
  :ensure t
  :config
  (apheleia-global-mode +1))

BASH

Navigating Bash set -x output

;; try to work with next-error for bash's "set -x" output
(use-package compile
  :ensure nil
  :config
  (add-to-list 'compilation-error-regexp-alist
               'bash-set-x)
  (add-to-list 'compilation-error-regexp-alist-alist
               '(pascal
                 "\\(.+?\\)\\(\\([0-9]+\\),\\([0-9]+\\)\\).*" 1 2 3)))

PHP

(use-package php-mode)

JSON, YAML Configuration files

YAML

(use-package yaml-mode)

json

(use-package json-reformat)
(use-package hydra)

Version Control

It’s Magit! A Git porcelain inside Emacs

(use-package transient)
(use-package
  magit
  :after transient
  :hook
  (magit-status-mode . magit-filenotify-mode)
  (git-commit-post-finish . magit)
  :bind
  ("C-x g" . magit-status))

(use-package magit-filenotify :after magit)

Forge ahead with Pull Requests

always causes issues. disabled.

(straight-use-package 'sqlite3)
(use-package forge
  :disabled
  :after magit)
token

-----BEGIN PGP MESSAGE-----

hQEMA7IjL5SkHG4iAQgAhMUIMTYGMMJOxJT9Cpd4yXSe7D3nYO1JLdyFFADgiHDq 1D68ig/iJdH5aPZNmKOOqSeI3zObJjDOnQ95+PK+DBDaDHlwJ/LWYdR/A4eWAh5G WcRqCn+diQ/amAXuaISDLBCpEa/GKS3kHObVf41VwL43INMAwssDI2rOFnhOEUWF jAWKyhzcS/D+1BqxV5XcloY8tn8qCZbLHOi1+YKr+ZeefFtJtmaqQtyjt6P1Z+H/ eCvdX0P4JdMm9Lp/fbzDQOPo8QVuWLKAWphMSfgCqetR5gfz9W/3+fcqzOP3amnt qTM3K7LywQOeiJhLgyhw5bemiEXIKuNygb7Wmmv5xNKEAc5/QrR0YnZIuEnDN4Gb aPjOOiu73X7xh76DX+5CxBXhQZzYtnqD8ctuenIMgvbD9AY1+H4fU0Wv6qGi9uNh Y0lSPvXH7dBCTWu2rSWhIvgCQfv6Nihs3Jc455oZgajN7G/rgZNb0ER8YTYncZjY gtVhIJfSArVFXuCGLnZMoMHSC4rV =MsQY -----END PGP MESSAGE-----

Git Window Gutter Support

diff-hl mode
(use-package diff-hl
  :demand t
  :hook
  (elpaca-after-init .  global-diff-hl-mode)
  (magit-post-refresh . diff-hl-magit-post-refresh))

Dart/Flutter

Running emulator from command line:

emulator -avd Pixel_6_Pro_API_33

Tree Sitter

treesit-auto

Automatically install and use tree-sitter major modes in Emacs 29+. If the tree-sitter version can’t be used, fall back to the original major mode.

(use-package treesit-auto
  :demand t
  :custom
  (treesit-auto-install t)
  :config
  (treesit-auto-add-to-auto-mode-alist 'all)
  (global-treesit-auto-mode))

****JavaScript Family

Javascript

(use-package js
  :ensure nil
  :demand t
  :init
  (add-to-list 'auto-mode-alist '("\\.mjs" . javascript-mode)) ;; js module file
  (defun rgr/javascript-typescript-common-mode-hook ()
    (electric-pair-mode 1)
    (setq-local rgr/complete-line-f 'rgr/complete-c-line)
    )
  :config
  (defun rgr/js-ts-mode-hook ()
    )
  :hook
  (js-ts-mode . rgr/javascript-typescript-common-mode-hook)
  (js-ts-mode . rgr/js-ts-mode-hook))

Typescript

(use-package typescript-ts-mode
  :ensure nil
  :demand t
  :init
  (defun rgr/typescript-ts-mode-hook ()
    )
  :hook
  (typescript-ts-mode .  rgr/javascript-typescript-common-mode-hook)
  (typescript-ts-mode .  rgr/typescript-ts-mode-hook))

Language Server Protocol (LSP)

Emacs-lsp : Language Server Protocol client for Emacs

***** eglot Emacs lsp client https://github.com/joaotavora/eglot

(use-package eglot
  :custom
  (eglot-autoshutdown t)
  (eglot-send-changes-idle-time 0.5)
  (eglot-ignored-server-capabilities '( :documentHighlightProvider));; dont let eglot/eldoc show doc, rather flymake.
  :config
  ;;(add-hook  'eglot-stay-out-of 'yasnippet)
  (advice-add 'eglot-completion-at-point :around #'cape-wrap-buster)
  (defun rgr/eglot-on-save()
    (when eglot--managed-mode
      (eglot-format-buffer)
      )
    )
  (defun rgr/eglot-managed-mode-hook()
    (message "rgr/eglot hook"))
  :hook
  (before-save . rgr/eglot-on-save)
  (eglot-managed-mode . rgr/eglot-managed-mode-hook)
  ((js-ts-mode c-ts-mode c++-ts-mode php-mode auctex-mode) . #'eglot-ensure)
  :bind
  (:map eglot-mode-map
        ("<C-return>" . eglot-code-actions)))

****** eglot-booster

(use-package eglot-booster :ensure (:host github :repo "jdtsmith/eglot-booster")
  :after eglot
  :config	(eglot-booster-mode))

***** dape

(use-package dape
  :demand t
  :custom
  (dape-default-breakpoints-file (expand-file-name  "var/dape/dape-breakpoints" user-emacs-directory ))
  (dape-buffer-window-arrangement 'right)
  (dape-info-hide-mode-line nil)
  (dape-inlay-hints t)
  ;;(dape-cwd-fn 'projectile-project-root)
  :hook
;; Save breakpoints on quit
  (kill-emacs . dape-breakpoint-save)
  ;; Load breakpoints on startup
  (elpaca-after-init . dape-breakpoint-load)
  ;;(dape-start . dape-breakpoint-load)
  (dape-display-source . pulsar-pulse-line)
  (dape-compile .  kill-buffer)

  :config
  ;; Turn on global bindings for setting breakpoints with mouse
  ;; (advice-add 'dape-quit :after (lambda(&rest r)(dape-breakpoint-save dape-default-breakpoints-file)))
  (add-to-list 'recentf-exclude "dape-breakpoints")
  (add-to-list 'recentf-exclude "var/org")
  (dape-breakpoint-global-mode)
  (add-hook 'dape-info-parent-mode-hook
            (defun dape--info-rescale ()
              (face-remap-add-relative 'default :height 0.8))))

*** Serial Port

(defgroup rgr/serial-ports nil
  "serial port customization"
  :group 'rgr)

(defcustom rgr/serialIOPort "/dev/ttyACM0"
  "Serial device for emacs to display"
  :type 'string
  :group 'rgr/serial-ports)

(defcustom rgr/serialIOPortBaud 9600
  "Default serial baud rate"
  :type 'integer
  :group 'rgr/serial-ports)

(defun selectSerialPortBuffer()
  (setq ser (get-buffer rgr/serialIOPort))
  (if ser (switch-to-buffer ser)
    (serial-term rgr/serialIOPort rgr/serialIOPortBaud)))

(global-set-key (kbd "C-c s")
                (lambda()
                  (interactive)
                  (selectSerialPortBuffer)))

*** PlatformIO

platformio-mode is an Emacs minor mode which allows quick building and uploading of PlatformIO projects with a few short key sequences. The build and install process id documented here.
(use-package platformio-mode
  :disabled t
  :custom

  (platformio-mode-silent nil)
  :init
  (require 'ansi-color)
  (defun rgr/platformio-compilation-mode-filter (buf _)
    (interactive)
    (with-current-buffer buf
      (when (derived-mode-p 'platformio-compilation-mode)
        (let ((inhibit-read-only t))
          (ansi-color-apply-on-region (point-min) (point-max))))))

  (add-hook 'compilation-finish-functions
            'rgr/platformio-compilation-mode-filter))

**** CANCELLED [#A] get compilation errors to work and submit ansi color fix? :CANCELLED:

  • State “CANCELLED” from “TODO” [2023-11-27 Mon 04:59]
  • State “TODO” from [2021-09-26 Sun 21:13]

Python

ipython

  • State “SOMEDAY” from [2021-04-03 Sa 09:41]
(setq python-shell-interpreter "ipython")
(setq python-shell-interpreter-args "-i --simple-prompt --InteractiveShell.display_page=True")

PET

(use-package pet
  :config
  (add-hook 'python-base-mode-hook 'pet-mode -10))

Haskell

haskell-mode

;; I'm typically confused when it comes to haskell. Note that the interactive stuff I cribbed doesnt work.
(use-package haskell-mode
  :disabled t
  :config
  (eval-after-load "haskell-mode"
    '(define-key haskell-mode-map (kbd "C-c C-c") 'haskell-compile))
  (eval-after-load "haskell-cabal"
    '(define-key haskell-cabal-mode-map (kbd "C-c C-c") 'haskell-compile))
  (add-hook 'haskell-mode-hook 'interactive-haskell-mode))

lldb debugging in emacs

voltron

(use-package lldb-voltron :disabled t
  :straight (lldb-voltron :local-repo "~/development/emacs/emacs-lldb-voltron" :type git :host github :repo "rileyrg/emacs-lldb-voltron" )
  ;;:config
  ;; (breadcrumb-mode t)
  )

rust

(use-package rust-mode
  :disabled t
  :ensure t
  :init
  (defcustom rgr/rust-browser-doc-url (concat (format "file://%s/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/share/doc/rust/html/std/index.html?search=" (getenv "HOME")) "%s") "used to format variable `rgr/browser-doc-url'")
  (setq rust-mode-treesitter-derive t))

(use-package rustic
  :disabled t
  :ensure t
  :after (rust-mode)
  :custom
  (rustic-cargo-use-last-stored-arguments t)
  :config
  (setq rustic-format-on-save t)
  (add-to-list 'rgr/eww-external-launch-url-chunks "doc/rust")
  (defun rgr/rust-mode-hook ()
    (message "rgr/rust-mode-hook")
    (setq-local rgr/browser-doc-url rgr/rust-browser-doc-url)
    (setq-local rgr/complete-line-f 'rgr/c-complete-line)
    (setq indent-tabs-mode nil)
    (prettify-symbols-mode))
  :hook
  (rustic-mode . rgr/rust-mode-hook)
  :bind
  (:map rustic-mode-map
        ("C-q" . rgr/browser-doc-search)))

C and CPP

c-mode-common-hook

(use-package c-ts-mode
  :ensure nil
  :config
  (defun rgr/c-ts-mode-common-hook ()
    (message "rgr/c-ts-mode-common-hook")
    (yas-minor-mode t) ;; This SHOULD be done by eglot but it doesnt work.
    (setq-local rgr/complete-line-f 'rgr/c-complete-line)
    (setq-local c-ts-mode-indent-offset 4))
  :hook
  ((c-ts-mode c++-ts-mode) . rgr/c-ts-mode-common-hook))

cmake

(setq auto-mode-alist
        (append
         '(("CMakeLists\\.txt\\'" . cmake-mode))
         '(("\\.cmake\\'" . cmake-mode))
         auto-mode-alist))

Linux tools

**** logview - view system logfiles
(use-package logview
  :demand t
  :init
  (add-to-list 'auto-mode-alist '("\\.log\\'" . logview-mode))
  (add-to-list 'auto-mode-alist '("log\\'" . logview-mode)))

Assembler

(use-package strace-mode)

Web,Symfony and Twig

Tasks

Symfony

custom
(defgroup rgr/symfony nil
  "Symfony Development"
  :group 'rgr)

(defcustom symfony-server-command "~/.symfony/bin/symfony server:start"
  "Start the symfony web server"
  :type 'string
  :group 'rgr/symfony)
Start a symfony web server when applicable
(use-package php-mode
  :disabled t
  :custom
  (lsp-intelephense-licence-key (get-auth-info "licenses" "intelephense"))
  :config
  (add-to-list 'display-buffer-alist
               (cons "\\*Symfony Web Server\\*.*" (cons #'display-buffer-no-window nil)))
  (defun start-symfony-web-server()
    (interactive)
    (let ((default-directory (project-root (project-current t))))
      (if (and default-directory (file-exists-p "bin/console") (eq (length (shell-command-to-string "pgrep symfony")) 0) (yes-or-no-p "Start web server?"))
          (async-shell-command symfony-server-command "*Symfony Web Server*"))))
  (defun php-mode-webserver-hook ()
    (interactive)
    (start-symfony-web-server)
    ))

We can trigger it using a .dir-locals.el

((php-mode
  (eval php-mode-webserver-hook)))

elf-mode - view the symbol list in a binary

https://oremacs.com/2016/08/28/elf-mode/
(use-package elf-mode
  :demand t
  :config
  (elf-setup-default))

Emacs Lisp, ELisp Utils

Load this relatively early in order to have utils available if there’s a faied load

kill-dwim

(setq killdwim-dir (expand-file-name "kill-dwim" rgr/emacs-project-dir ))
(setq load-path (cons (expand-file-name "kill-dwim" rgr/emacs-project-dir ) load-path))
(use-package kill-dwim
  :ensure nil
  :bind
  ("M-w" . kill-dwim))

Flymake

(use-package flymake
  :custom
  (flymake-show-diagnostics-at-end-of-line nil)
  (flymake-no-changes-timeout 1.5)
  :bind
  ("M-n" . flymake-goto-next-error)
  ("M-p" . flymake-goto-prev-error))

shellcheck

(use-package flymake-shellcheck
  :disabled t
  :commands flymake-shellcheck-load
  :init
  (defun rgr/sh-mode-hook()
    (flymake-shellcheck-load)
    (flymake-mode +1))
  :hook (sh-mode . rgr/sh-mode-hook))

rgr/emacs-lisp-help

Use helpful if installed else built in
(defun rgr/emacs-lisp-help (&optional s)
  "Elisp help at point. default to `helpful-at-point' if available, else `describe-function' or `describe-variable'."
  (interactive)
  (let* ((sym (or s (thing-at-point 'symbol)))
         (sym (if (symbolp sym) sym (intern-soft sym))))
    (when sym
      (if (fboundp sym)
          (if (featurep 'helpful)
              (helpful-function sym)
            (describe-function sym))
        (if (boundp sym)
            (if (featurep 'helpful)
                (helpful-variable sym)
              (describe-variable sym))
          (progn
            (let ((msg (format "No elisp help for '%s" sym)))
              (emacs-alert msg))
            (setq sym nil)))))))

external info files

(require 'info)
(add-to-list 'Info-directory-list (expand-file-name  "var/info" user-emacs-directory))

smartparens

  • State “CANCELLED” from [2021-05-09 Sun 11:35]
    too much hassle. not 1337 enough
(use-package smartparens
  :hook
  ((emacs-lisp-mode . smartparens-mode)))

electric-pair-mode

  • State “CANCELLED” from [2021-05-13 Thu 21:53]
auto insert closing brackets
(add-hook 'emacs-lisp-mode  'electric-pair-mode)

elisp checks

(defun rgr/elisp-edit-mode()
  "return non nil if this buffer edits elisp"
  (member major-mode '(emacs-lisp-mode lisp-interaction-mode)))

linting

package-lint provides a linter for the metadata in Emacs Lisp files which are intended to be packages. You can integrate it into your build process.
(use-package package-lint)

helpful, enriched elisp help

(use-package helpful)

elisp popup context help

  • State “STARTED” from “CANCELLED” [2021-04-20 Di 08:11]
  • State “CANCELLED” from [2021-04-20 Di 01:04]
    eldoc-box does this
Display a poup containing docstring at point
(setq elsap-dir (expand-file-name "el-docstring-sap" rgr/emacs-project-dir))
(setq load-path (cons (expand-file-name "el-docstring-sap" rgr/emacs-project-dir ) load-path))
(use-package quick-peek)
(use-package el-docstring-sap
  :ensure nil
  :hook
  (emacs-lisp-mode . el-docstring-sap-mode)
  :bind
  ("M-<f2>" . el-docstring-sap-display)
  ("M-<f1>" . el-docstring-sap-mode))

Elisp debugging

edebug

(use-package edebug-x
  :custom
  (debugger-stack-frame-as-list t)
  ;;(edebug-trace nil)
  :config
  (defun rgr/instrumentForDebugging() "use the universal prefix arg (C-u) to remove instrumentation"
         (interactive)
         (if current-prefix-arg (eval-defun nil)
           (eval-defun 0)))
  :bind
  ("C-S-<f9>" . toggle-debug-on-error)
  ("C-<f9>" . rgr/instrumentForDebugging))

display value at point in edebug

;; bit more convoluted than it needs to be
;; but I fancied using thing-at-point
(defun rgr/edebug-display-thing-at-point()
  (let ((tap (thing-at-point 'var)))
    (if tap
        (message "%s: %s" (nth 0 tap) (nth 1 tap)))))

(defun rgr/edebug-thing-at-point()
  "message display the vale of the symbol at point"
  (let((tap (thing-at-point 'symbol)))
    (if tap
        (let((sym (if (symbolp tap) tap (intern-soft tap))))
          (condition-case nil
              (list sym (edebug-eval  sym))
            (error nil))))))

(defun rgr/edebug-mode-hook()
  (setq-local thing-at-point-provider-alist
              (append thing-at-point-provider-alist
                      '((var . rgr/edebug-thing-at-point))))
  "add a call to display the value at point when debugging with edebug"
  (add-hook 'post-command-hook #'rgr/edebug-display-thing-at-point nil :local))

(add-hook 'edebug-mode-hook  #'rgr/edebug-mode-hook)

popup query symbol

(use-package popup
  :config
  (defun rgr/show-symbol-details ()
    (interactive)
    (popup-tip (format "intern-soft thing-at-point: %s, symbolp: %s, symbol-name:%s"
                       (setq-local sym (intern-soft (thing-at-point 'symbol)))
                       (symbolp sym)
                       (symbol-name sym))))
  :bind
  (:map emacs-lisp-mode-map (("M-6" . #'rgr/show-symbol-details))))

General configuration

general ui

(show-paren-mode 1)
(winner-mode 1)

(repeat-mode)

(global-auto-revert-mode 1)
;; Also auto refresh dired, but be quiet about it
(setq global-auto-revert-non-file-buffers t)
(setq auto-revert-verbose nil)
(setq auto-revert-use-notify nil)

(global-visual-line-mode 1)

(setq column-number-mode t)

(delete-selection-mode 1)

;; (setq frame-title-format (if (member "-chat" command-line-args)  "Chat: %b" '("%b@" (:eval (or (file-remote-p default-directory 'host) system-name)) " — Emacs")))

(defalias 'yes-or-no-p 'y-or-n-p)

(setq disabled-command-function nil)

(global-hl-line-mode t)

(use-package delsel
  :ensure nil
  :hook (after-init . delete-selection-mode))

(defun prot/keyboard-quit-dwim ()
  "Do-What-I-Mean behaviour for a general `keyboard-quit'.

The generic `keyboard-quit' does not do the expected thing when
the minibuffer is open.  Whereas we want it to close the
minibuffer, even without explicitly focusing it.

The DWIM behaviour of this command is as follows:

- When the region is active, disable it.
- When a minibuffer is open, but not focused, close the minibuffer.
- When the Completions buffer is selected, close it.
- In every other case use the regular `keyboard-quit'."
  (interactive)
  (cond
   ((region-active-p)
    (keyboard-quit))
   ((derived-mode-p 'completion-list-mode)
    (delete-completion-window))
   ((> (minibuffer-depth) 0)
    (abort-recursive-edit))
   (t
    (keyboard-quit))))

(define-key global-map (kbd "C-g") #'prot/keyboard-quit-dwim)

;; https://github.com/rolandwalker/browse-url-dwim
;; Context-sensitive external browse URL or Internet search from Emacs.
(use-package
  browse-url-dwim
  :config
  (browse-url-dwim-mode))

;; display dir name when core name clashes
(require 'uniquify)

(defun rgr/kill-current-buffer()
  (interactive)
  (if (member (buffer-name) '("*Messages*" "*scratch*"))
      (progn
        (message "Can't delete %s. Are you mad? Closing window instead." (buffer-name))
        (delete-window))
    (kill-current-buffer)
    (delete-window)))

(bind-keys
  ("C-x C-q" . view-mode)
  ( "C-x C-b" . ibuffer)
  ( "C-x C-i" . imenu)
  ( "C-x k" . rgr/kill-current-buffer)
  ( "M-0" . delete-window)
  ( "M-1" . delete-other-windows)
  ( "S-<f1>" . describe-face)
  (  "M-m"  . manual-entry)
  ( "S-<f10>" . menu-bar-open))

posframe

Posframe can pop up a frame at point, this posframe is a child-frame connected to its root window’s buffer.
(use-package posframe)

ACE utilities

Ace-Window provides better window switching.

(use-package ace-window
  :demand t
  ;; (defalias 'other-window 'ace-window)
  :init
  (windmove-default-keybindings)
  :bind
  ("M-o" . ace-window)
  ("M-d" . ace-delete-window))

hopping around links

Quickly follow links in Emacs.
(use-package ace-link
  :demand
  :config
  (ace-link-setup-default))

pulsar

visual feedback as to cursor position https://protesilaos.com/emacs/pulsar

(use-package pulsar
  :custom
  (pulsar-pulse t)
  (pulsar-delay 0.2)
  (pulsar-iterations 15)
  (pulsar-face 'isearch)
  (pulsar-highlight-face 'pulsar-green)
  :init
  (add-hook 'minibuffer-setup-hook #'pulsar-pulse-line)
  (add-hook 'consult-after-jump-hook #'pulsar-recenter-middle)
  (add-hook 'consult-after-jump-hook #'pulsar-reveal-entry)
  :config
  (
   pulsar-global-mode 1))

boxquote

(use-package boxquote
  ;;:straight (:branch "main")
  :bind
  ("C-S-r" . boxquote-region))

volatile-highlights

brings visual feedback to some operations by highlighting portions relating to the operations.

(use-package
  volatile-highlights
  :init (volatile-highlights-mode 1))

web pasting

(use-package
  dpaste
  :init
  :bind ("C-c y" . dpaste-region-or-buffer))

Accessibility

fonts

JetBrains fonts are nice. See nerd-fonts
;;(set-frame-font "-JB-JetBrainsMono Nerd Font-regular-normal-normal-*-14-*-*-*-*-0-fontset-auto1" nil t)

**** Darkroom

Zoom in and center using darkroom.
(use-package
  darkroom
  :bind
  ( "<C-f7>" . 'darkroom-mode))

*** Ansi colour

Ansi colour hooks to enable emacs buffers to handle ansi.
(require 'ansi-color)
(add-hook 'shell-mode-hook 'ansi-color-for-comint-mode-on)
(add-to-list 'comint-output-filter-functions 'ansi-color-process-output)

*** Tabs

(defun consult-buffer-other-tab ()
  "Variant of `consult-buffer' which opens in other tab."
  (interactive)
  (let ((consult--buffer-display #'switch-to-buffer-other-tab))
    (consult-buffer)))

(use-package tab-bar
  :ensure nil
  :defer t
  :custom
  (tab-bar-show t)
  (tab-bar-close-button-show nil)
  (tab-bar-new-button-show nil)
  (tab-bar-tab-hints t)
  (tab-bar-new-tab-choice "*scratch*")
  (tab-bar-select-tab-modifiers '(control))
  :custom-face
  (tab-bar ((t (:background "gray24" :foreground "#ffffff"))))
  (tab-bar-tab-inactive ((t (:background "gray24" :foreground "#ffffff"))))
  (tab-bar-tab ((t (:background "black" :foreground "#ffffff"))))
  :bind (:map tab-prefix-map
               ("b" . consult-buffer-other-tab)))

*** buffer utlities

(defun get-buffers-with-minor-mode (minor-mode)
  "Get a list of buffers in which minor-mode is active"
  (interactive)
  (let ((minor-mode-buffers))
    (dolist (buf (buffer-list) minor-mode-buffers)
      (with-current-buffer buf
        (when (memq minor-mode (manage-minor-mode--active-list))
          (push buf minor-mode-buffers))))))


(defun get-buffers-with-major-mode (m-mode)
  "Get a list of buffers in which minor-mode is active"
  (interactive)
  (let ((major-mode-buffers)) 
    (dolist (buf (buffer-list) major-mode-buffers)
      (with-current-buffer buf
        (when (string= major-mode m-mode)
          (push buf major-mode-buffers))))))   ;; (nth 0 (get-buffers-with-major-mode "dired-mod"))

;; Taken from https://github.com/ShingoFukuyama/manage-minor-mode
(defun manage-minor-mode--active-list ()
  "Get a list of which minor modes are enabled in the current buffer."
  (let ($list)
    (mapc (lambda ($mode)
            (condition-case nil
                (if (and (symbolp $mode) (symbol-value $mode))
                    (setq $list (cons $mode $list)))
              (error nil)))
          minor-mode-list)
    (sort $list 'string<)))

*** switch to dired buffer else open it

(defvar rgr/last-dired nil "last dired buffer opened")
(add-hook 'dired-after-readin-hook (lambda()(setq rgr/last-dired (buffer-name))))
(defun switch-to-dired(&optional d)
  (if (and rgr/last-dired (get-buffer rgr/last-dired))
      (switch-to-buffer rgr/last-dired)
    (let ((db (nth 0 (last (get-buffers-with-major-mode "dired-mode")))))
      (if db (switch-to-buffer db)
        (dired (if d d "~"))))))

*** multiple-cursors https://github.com/magnars/multiple-cursors.el

(use-package multiple-cursors
  :bind
  ("C-<mouse-1>" . mc/add-cursor-on-click)
  ("C-S-n" . mc/mark-next-like-this)
  ("C-S-p" . mc/mark-previous-like-this)
  ("C-c C->" . mc/mark-all-like-this)
  ("C-c C-SPC" . mc/edit-lines)
  )

*** jinx : the enchanted spell checker

(use-package jinx
  :bind
  ("<f8>" . jinx-correct)
  ("S-<f8>" . jinx-correct-word)
  ("C-<f8>" . jinx-languages))

Late load-dir

(add-hook 'elpaca-after-init-hook (lambda()(load-el-gpg (expand-file-name "etc/late-load" user-emacs-directory))))

IRC init file

This tangles to its own init file init-irc.el and locks down emacs a little. This is so I can run an erc “session” without interfering with other emacsy things.

erc

;; generally loaded from init-erc.el ins a kiosk like mode
(require 'erc)

(add-hook 'find-file-hook (lambda()(read-only-mode 1)))
(set-face-background 'mode-line "orangered")
(defun my/erc-buffer-connected-p (buffer)
  "Check if ERC BUFFER is connected."
  (with-current-buffer buffer
    (and (erc-server-process-alive)
         erc-server-connected)))

;;https://emacs.stackexchange.com/questions/64361/how-to-check-if-erc-is-running
(defun my/erc-start-or-switch ()
  "Connects to ERC, or switch to last active buffer.

  This function serves multiple purposes:

  1. Check Active Buffers: It iterates through a predefined list of ERC buffers
     to determine if any of them are actively connected to an IRC server.

  2. Verify Connection Status: For each buffer, it checks whether the associated
     ERC process is alive and whether there is an established network connection
     to the server. This is done using the `erc-server-process-alive' function and
     the `erc-server-connected' variable.

  3. Switch to Active Buffer: If any buffer is found to be actively connected,
     the function switches to that buffer using `erc-track-switch-buffer'.

  4. Reconnect if Disconnected: If none of the checked buffers are connected,
     the function prompts the user to reconnect to the IRC server. If the user
     confirms, a new connection is initiated using the `erc' command with the
     server and port specified (`irc.libera.chat` on port 6667)."
  (interactive)
  (let ((erc-buffers '("Libera.Chat" "irc.libera.chat" "irc.libera.chat:6667"))
        (connected nil))
    (dolist (buffer erc-buffers)
      (when (and (get-buffer buffer)
                 (my/erc-buffer-connected-p buffer))
        (setq connected t)))
    (if connected
        (rgr/erc-switch-to-channel)
      (progn
        (emacs-alert "Connecting to IRC")
        (erc :server "irc.libera.chat" :port 6667)
        (global-set-key (kbd "C-c C-q") 'rgr/irc-quit )
        (global-set-key (kbd "C-c x")  'rgr/irc-quit)))))

(defun rgr/erc-switch-to-channel(&optional channel)
  (let ((c (or channel "#emacs")))
    (if (get-buffer c)
        (switch-to-buffer c))))

(setq kill-emacs-hook nil)

(add-hook 'server-after-make-frame-hook 'my/erc-start-or-switch)

(defun rgr/irc-quit()
  (interactive)
  (erc-quit-server "")
  (call-interactively 'ement-disconnect)
  (when rgr/irc-session
    (kill-emacs)))

matrix client ement

(use-package ement
  :demand t
  :hook (server-after-make-frame . (lambda()(call-interactively 'ement-connect)))
  :bind ("M-g M-l" . 'ement-room-list))

Associated emacs things

Project version control with git

.gitignore

An exclusionary .gitignore. You need to specfically add in things you wish to add to version control.

Setting up emacs as a default editor using a dot desktop file and associated protocol handler

php.ini changes e.g /etc/php/7.3/php.ini

xdebug.file_link_format is used by compliant apps to format a protocol uri. This is handled on my Linux system as a result of emacsclient.desktop documented below.
xdebug.file_link_format = "emacsclient://%f@%l"

xdebug.remote_enable = 1
xdebug.remote_host = localhost
xdebug.remote_port = 9000

emacsclient-linenumber script to correctly parse the protocol in order to start emacs frame at correct line

#!/usr/bin/bash
# Maintained in emacs-config.org
export GDK_NATIVE_WINDOWS=1
file=`echo "$@" | sed 's/.*://;s/@.*$//'`
line=`echo "$@" | sed 's/.*@//'`
echo $file
echo $line

re='^[0-9]+$'
if ! [[ $line =~ $re ]] ; then
    exec emacsclient -c -a ""  $file
else
    exec emacsclient -c -a "" +$line  $file
fi

Gnome protocol handler desktop file

Copy emacsclient.desktop to ~/.local/share/applications (Debian & Gnome - your mileage may vary…)
[Desktop Entry]
Name=Emacs (Client)
GenericName=Text Editor
Comment=Edit text
MimeType=text/english;text/plain;text/x-makefile;text/x-c++hdr;text/x-c++src;text/x-chdr;text/x-csrc;text/x-java;text/x-moc;text/x-pascal;text/x-tcl;text/x-tex;application/x-shellscript;text/x-c;text/x-c++;
Exec=emacsclient -c -a "" %F
Icon=emacs
Type=Application
Terminal=false
Categories=Development;TextEditor;Utility;
StartupWMClass=Emacs

Update the desktop database:

update-desktop-database ~/.local/share/applications

now allows emacsclient to be called.

note: symlink the deprecated ~/.local/share/applications/mimeapps.lst to the one in ~/.config

ln -sf  ~/config/mimeapps.lst ~/.local/share/applications/

Always using emacsclient

Set up a zshrc alias so that “emacs” actually invokes emacs client. In my .zshrc:
alias emacs='emacsclient --create-frame --alternate-editor=""'

bin/emacs-same-frame open emacs in the same frame

#!/bin/bash
if ! pidof "emacs"; then
    emacsclient -n -c -a "" "$@"
else
    emacsclient -e "(if (> (length (frame-list)) 1) 't)" | grep -q t
    if [ "$?" = 1 ]; then
        emacsclient -n -c -a "" "$@"
    else
        emacsclient -n -a "" "$@"
        pop-window "Emacs"
    fi
fi