Files
.emacs.d/setup-emacs.org

25 KiB

Emacs Configuration

This is my configuration for the emacs editor.

Set up UI

Remove all those UI elements. They do not look good and waste space.

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

Desktop Mode

Using desktop mode emacs will save the state of all buffers, their cursor positions, window arrangements and other things when exiting. When starting these states are restored.

  (desktop-save-mode 1)

For more information take a look at the Emacs Manual

Set up package repositories

Require package support

State that we will need package support and define a macro for adding package repos to the archives

  (require 'package)
  (defmacro append-to-list (target suffix)
   "Append SUFFIX to TARGET in place."
   `(setq ,target (append ,target ,suffix)))

Add package repos

  (append-to-list package-archives
                  '(("melpa" . "http://melpa.org/packages/")
                    ("melpa-stable" . "http://stable.melpa.org/packages/")
                    ("org-elpa" . "https://orgmode.org/elpa/")))

Ensure use-package command is present

  (package-initialize)

  (unless (package-installed-p 'use-package)
    (package-refresh-contents)
    (package-install 'use-package))

  (require 'use-package)

  (setq
   use-package-always-ensure t
   use-package-verbose t)

   (use-package gnu-elpa-keyring-update)

Set Backup Location

Emacs, by default clutters the file system with backup files. We do not want them to be right next to the actual file, so we tell emacs to use dedicated directory to store them. While we are at it, we also set rule for how many version emacs should keep as backups.

  (setq backup-directory-alist `(("." . "~/.emacs-backup")))
  (setq backup-by-copying t)
  (setq delete-old-versions t
    kept-new-versions 6
    kept-old-versions 2
    version-control t)

Define useful functions

Reformat a whole buffer

Reindet the whole buffer with F12

  (defun indent-buffer ()
        (interactive)
        (save-excursion
          (indent-region (point-min) (point-max) nil)))
      (global-set-key [f12] 'indent-buffer)

Split windows and immediately switch to it

  (defun split-right-and-enter ()
    "Split the window to the right and enter it."
    (interactive)
    (split-window-right)
    (other-window 1))

  (defun split-below-and-enter ()
    "Split the window down and enter it."
    (interactive)
    (split-window-below)
    (other-window 1))

Quick buffer switching

  (defun switch-to-previous-buffer ()
    "Switch to previously open buffer.  Repeated invocations toggle between the two most recently open buffers."
    (interactive)
    (switch-to-buffer (other-buffer (current-buffer) 1)))

Theming

Main Theme

  (use-package doom-themes)

  ;; 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 the theme (doom-one, doom-molokai, etc); keep in mind that each theme
  ;; may have their own settings.
  (load-theme 'doom-one-light t)

  ;; Enable flashing mode-line on errors
  (doom-themes-visual-bell-config)

  ;; Corrects (and improves) org-mode's native fontification.
  (doom-themes-org-config)

Modeline

  (use-package doom-modeline
   :ensure t
   :hook (after-init . doom-modeline-mode))

Minions Menu

Add a menu to the modeline to access all minor modes.

  (use-package minions
    :config (minions-mode 1))

Font

  (set-face-attribute 'default nil
                      :family "Hack"
                      :height 110
                      :weight 'normal
                      :width 'normal)

Ivy

Use Ivy to make minibuf promts better. Adds the ability to sort and filter.

Use Ivy

 (use-package ivy
   :ensure t
   :init
   (ivy-mode 1)
   (unbind-key "S-SPC" ivy-minibuffer-map)
   (setq ivy-height 30
         ivy-use-virtual-buffers t
         ivy-use-selectable-prompt t)
   (defun swiper-at-point ()
     (interactive)
     (swiper (thing-at-point 'word)))
   :bind (("C-x b"   . ivy-switch-buffer)
          ("C-c C-r" . ivy-resume)
          ("C-c s"   . swiper-at-point)
          ("C-s"     . swiper))
   :diminish)

 ;; ivy-rich makes Ivy look a little bit more like Helm.
 (use-package ivy-rich
   :after counsel
   :custom
   (ivy-virtual-abbreviate 'full
    ivy-rich-switch-buffer-align-virtual-buffer t
    ivy-rich-path-style 'abbrev)
   :init
   (ivy-rich-mode))

 (use-package ivy-hydra)

Smex

Sort commands by recency in ivy windows

  (use-package smex)

Counsel

  (use-package counsel
    :ensure t
    :after ivy
    :init
    (counsel-mode 1)

    :bind (("C-c ;" . counsel-M-x)
           ("C-c U" . counsel-unicode-char)
           ("C-c i" . counsel-imenu)
           ("C-x f" . counsel-find-file)
           ("C-c y" . counsel-yank-pop)
           ("C-c r" . counsel-recentf)
           :map ivy-minibuffer-map
           ("C-r" . counsel-minibuffer-history))
    :diminish)

Undo Tree

Using the beauty that is undo-tree, we can easily navigate through history of a buffer. This includes obviously going back in edit history, but also branching of end returning to previous states.

  (use-package undo-tree
    :bind (("C-x u" . undo-tree-visualize)
           ("C-z"   . undo-tree-undo)
           ("C-S-z" . undo-tree-redo))
    :config
    (global-undo-tree-mode +1)
    (unbind-key "M-_" undo-tree-map)
    :diminish)

  ;; Trying undo-propose, which seems to offer a better experience, as
  ;; undo tree is prone to losing data.
  (use-package undo-propose
    :disabled
    :bind (("C-c _" . undo-propose)
           :map undo-propose-mode-map
           ("<up>" . undo-only)))

With this we can use C-x u in any buffer to bring up the tree and navigate it using the arrow key. Once in a state we agree with, just press q and we are done.

Magit

Magit is THE go to package for using git in emacs.

  (use-package magit
    :bind (("C-c g" . magit-status))
    :diminish magit-auto-revert-mode
    :diminish auto-revert-mode
    :custom
    (magit-remote-set-if-missing t)
    (magit-diff-refine-hunk t)
    :config
    (magit-auto-revert-mode t)
    (advice-add 'magit-refresh :before #'maybe-unset-buffer-modified)
    (advice-add 'magit-commit  :before #'maybe-unset-buffer-modified)
    (setq magit-completing-read-function 'ivy-completing-read)
    (add-to-list 'magit-no-confirm 'stage-all-changes))

  (use-package libgit
    :disabled
    :after magit)

The advice-add entries are thereto stop magit from bugging us to save buffers when commiting and refreshing.

Helper Functions

  (autoload 'diff-no-select "diff")
  (defun current-buffer-matches-file-p ()
    "Return t if the current buffer is identical to its associated file."
    (when (and buffer-file-name (buffer-modified-p))
      (diff-no-select buffer-file-name (current-buffer) nil 'noasync)
      (with-current-buffer "*Diff*"
        (and (search-forward-regexp "^Diff finished \(no differences\)\." (point-max) 'noerror) t))))

Clear modified bit on all unmodified buffers

  (defun maybe-unset-buffer-modified (&optional _)
    (interactive)
    (dolist (buf (buffer-list))
      (with-current-buffer buf
        (when (and buffer-file-name (buffer-modified-p) (current-buffer-matches-file-p))
          (set-buffer-modified-p nil)))))

Don't prompt to save unmodified buffers on exit.

  (advice-add 'save-buffers-kill-emacs :before #'maybe-unset-buffer-modified)
  (defun kill-buffer-with-prejudice (&optional _)
    "Kill a buffer, eliding the save dialogue if there are no diffs."
    (interactive)
    (when (current-buffer-matches-file-p) (set-buffer-modified-p nil))
    (kill-buffer))

Org Mode

Define important files

The Link Dump

I use a single file to dump all links I plan on viewing later.

  (defun open-link-list ()
    (interactive)
    (find-file "~/Notes/links.org"))

The Quick Note File

This file serves as a notepad for wirting down all sorts of things that have not yet been refiled.

  (defun open-semantic-notes ()
    (interactive)
    (find-file "~/Notes/semantic.org"))

The TODO File

This file will track the bulk of all todo items we will enter.

  (defun open-main-todo-file ()
    (interactive)
    (find-file "~/Notes/todo.org"))

The Tracking file

I use this file to capture dates, at wich I do certain tasks. Used mostly for keeping track of habits.

  (defun open-main-todo-file ()
    (interactive)
    (find-file "~/Notes/tracking.org"))

Configure org-mode

This is the main configuration for the infamous org-mode. The most important parts are configuring key bindings to quickly access the files we have defined above.

 (use-package org
   ;; Always get this from the GNU archive.
   :pin gnu
   :diminish org-indent-mode
   :bind (("C-c o c"  . org-capture)
          ("C-c o n"  . open-semantic-notes)
          ("C-c o t"  . open-main-todo-file)
          ("C-c o l"  . open-link-list)
          ("C-c o s"  . org-store-link)
          ("C-c o a"  . org-agenda)
          :map org-mode-map
          ("M-s-<return>" . org-insert-todo-heading)
          ("C-c c"    . org-mode-insert-code)
          ("C-c a s"  . org-emphasize)
          ("C-c a r"  . org-ref)
          ("C-c a e"  . outline-show-all)
          ("C-c a t"  . unindent-by-four))
   :hook (org-mode . visual-line-mode)
   :config

   (let ((todo-path (expand-file-name "~/Notes/todo.org")))
     (when (file-exists-p todo-path)
       (setq org-agenda-files (list todo-path)
             org-default-notes-file todo-path)))

   (setq org-footnote-section ""
         org-startup-with-inline-images t
         org-pretty-entities t
         org-ellipsis "…"
         org-footnote-section nil
         org-hide-leading-stars nil
         )
   (setcar (nthcdr 4 org-emphasis-regexp-components) 4)

   (defun org-mode-insert-code ()
     (interactive)
     (org-emphasize ?~)))

Set default archive location

When archiving items in org files, the default ist to crate a separate file named <filename>.org_archive. This clutters up my notes folder quite a bit, as I use a lot of separate files with thier respective archives. All archives should be stored in a single .archive file per directory.

  (setq org-archive-location "./.archive::* From %s")

Beautify org-mode

Icons for headline indentation

 (use-package org-bullets
   :init (add-hook 'org-mode-hook (lambda () (org-bullets-mode 1))))

Replace checkmark with unicode icons

  (use-package pretty-mode
    :init (global-pretty-mode t))

  (add-hook 'org-mode-hook (lambda ()
     "Beautify Org Checkbox Symbol"
     (push '("[ ]" . "☐") prettify-symbols-alist)
     (push '("[X]" . "☑" ) prettify-symbols-alist)
     (push '("[-]" . "❍" ) prettify-symbols-alist)
     (prettify-symbols-mode)))

Strike out done ckeckbox items

  (defface org-checkbox-done-text
    '((t (:foreground "#71696A" :strike-through t)))
    "Face for the text part of a checked org-mode checkbox.")

  (font-lock-add-keywords
   'org-mode
   `(("^[ \t]*\\(?:[-+*]\\|[0-9]+[).]\\)[ \t]+\\(\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\[\\(?:X\\|\\([0-9]+\\)/\\2\\)\\][^\n]*\n\\)"
      1 'org-checkbox-done-text prepend))
   'append)

CSS Themes for Exports

When exporting from org-mode (usually to HTML) we want to specify additional styles.

  (defvar org-theme-css-dir "~/.emacs.d/org-css/")

Pack some .css files into this directory. They will be available for choosing when exporting. The folowing code will define a function to inline css into a self-contained html file.

To use it type M-x toggle-org-custom-inline-style into an org-mode buffer. When exporting to HTML emacs will ask which css theme to use.

  (defun toggle-org-custom-inline-style ()
    (interactive)
    (let ((hook 'org-export-before-parsing-hook)
          (fun 'set-org-html-style))
      (if (memq fun (eval hook))
          (progn
            (remove-hook hook fun 'buffer-local)
            (message "Removed %s from %s" (symbol-name fun) (symbol-name hook)))
        (add-hook hook fun nil 'buffer-local)
        (message "Added %s to %s" (symbol-name fun) (symbol-name hook)))))

  (defun org-theme ()
    (interactive)
    (let* ((cssdir org-theme-css-dir)
           (css-choices (directory-files cssdir nil ".css$"))
           (css (completing-read "theme: " css-choices nil t)))
      (concat cssdir css)))

  (defun set-org-html-style (&optional backend)
    (interactive)
    (when (or (null backend) (eq backend 'html))
      (let ((f (or (and (boundp 'org-theme-css) org-theme-css) (org-theme))))
        (if (file-exists-p f)
            (progn
              (set (make-local-variable 'org-theme-css) f)
              (set (make-local-variable 'org-html-head)
                   (with-temp-buffer
                     (insert "<style type=\"text/css\">\n<!--/*--><![CDATA[/*><!--*/\n")
                     (insert-file-contents f)
                     (goto-char (point-max))
                     (insert "\n/*]]>*/-->\n</style>\n")
                     (buffer-string)))
              (set (make-local-variable 'org-html-head-include-default-style)
                   nil)
              (message "Set custom style from %s" f))
          (message "Custom header file %s doesnt exist")))))

Prettier Timestamps in Exports

The default timestamps look pretty unintuitive, with all the angle brackets and all. Let's make them look better.

  ;;(add-to-list 'org-export-filter-timestamp-functions
  ;;             #'endless/filter-timestamp)
  ;;(defun endless/filter-timestamp (trans back _comm)
  ;; (pcase back
  ;;    ((or `jekyll `html)
  ;;     (replace-regexp-in-string "&[lg]t;" "" trans))
  ;;    (`latex
  ;;     (replace-regexp-in-string "[<>]" "" trans))))

Removed for now, this somehow breaks emacs

OK, no more brackets. Now for a better formatted display.

  (setq-default org-display-custom-times t)
  (setq org-time-stamp-custom-formats
        '("<%a %d.%m.%Y>" . "<%d.%m.%y %H:%M>"))

Templates

Babel

Here we set custom templates to be used for structure expansion. These are used when we type "<" folowed by the shortcut for a template and hit "TAB". e.g. "<s TAB" expands to #+BEGIN_SRC ?\n\n#+END_SRC

emacs-lisp

Shortcut for creating emacs-lisp code blocks. This is used extensively in this very file.

  (add-to-list 'org-structure-template-alist '("el" "#+BEGIN_SRC emacs-lisp\n?\n#+END_SRC"))

Capture Support Functions

First we define a function to look the subheading under which we want to file captures:

  (defun org-get-target-headline (&optional targets prompt)
    "Prompt for a location in an org file and jump to it.

  This is for promping for refile targets when doing captures.
  Targets are selected from `org-refile-targets'. If TARGETS is
  given it temporarily overrides `org-refile-targets'. PROMPT will
  replace the default prompt message.

  If CAPTURE-LOC is is given, capture to that location instead of
  prompting."
    (let ((org-refile-targets (or targets org-refile-targets))
          (prompt (or prompt "Capture Location")))
      (org-refile t nil nil prompt))
    )

Org Capture

Here we define templates we want to use to quickly capture stuff and automatically file them away.

  (setq org-capture-templates
        '(("l" "Link" entry (file "~/Notes/links.org")
           "* NEW %?\n:PROPERTIES:\n:CREATED: %U\n:END:\n%i\n")
          ("t" "Track" table-line (file+function "~/Notes/tracking.org" org-get-target-headline)
           "| %? |  |")))

Additional Package Imports

All The Icons

We want to have some nice looking icons

 (use-package all-the-icons)

Recentf

Show recent files in the buffer selection

 (use-package recentf
   :init (recentf-mode t)
   :config
   (add-to-list 'recentf-exclude "\\.emacs.d")
   (add-to-list 'recentf-exclude ".+tmp......\\.org"))

Rainbow Delimiters

We want to have some nicely colored delimiters when reading and writing lisp code

 (use-package rainbow-delimiters
   :hook (prog-mode . rainbow-delimiters-mode))

Markdown Mode

  (use-package markdown-mode
    :mode ("\\.md$" . gfm-mode)
    :config
    (when (executable-find "pandoc")
      (setq markdown-command "pandoc -f markdown -t html")))

Duplicate Thing

Quick bind to ~C-c u ~ to duplicate the current line

  (use-package duplicate-thing
    :bind (("C-c u" . duplicate-thing)))

Guide Key

Use this to get some help with key bindings

  (use-package guide-key
    :diminish guide-key-mode
    :config
    (guide-key-mode t)
    (setq guide-key/guide-key-sequence '("C-x v" ;; version control
                                         "C-c a" ;; my mode-specific bindings
                                         "C-c l" ;; line-jumping
                                         "C-c o"
                                         )))

ACE Window

Small package to quickly switch tiled windows. Use M-p to quickly switch.

  (use-package ace-window
    :bind (("M-o" . 'ace-window)))

htmlize

HTML Exporter for org-mode

  (use-package htmlize)

Set Variables

General Emacs Options

  (setq
    compilation-always-kill t                ; Never prompt to kill a compilation session.
    compilation-scroll-output 'first-error   ; Always scroll to the bottom.
    make-backup-files nil                    ; No backups, thanks.
    auto-save-default nil                    ; Or autosaves. What's the difference between autosaves and backups?
    create-lockfiles nil                     ; Emacs sure loves to put lockfiles everywhere.
    default-directory "~/Notes/"             ; All my Notes are here.
    inhibit-startup-screen t                 ; No need to see GNU agitprop.
    kill-whole-line t                        ; Lets C-k delete the whole line
    require-final-newline t                  ; Auto-insert trailing newlines.
    ring-bell-function 'ignore               ; Do not ding. Ever.
    use-dialog-box nil                       ; Dialogues always go in the modeline.
    initial-scratch-message nil              ; SHUT UP SHUT UP SHUT UP
    save-interprogram-paste-before-kill t    ; preserve paste to system ring
    enable-recursive-minibuffers t           ; don't fucking freak out if I use the minibuffer twice
    sentence-end-double-space nil            ; are you fucking kidding me with this shit
    confirm-kill-processes nil               ; don't whine at me when I'm quitting.
    mark-even-if-inactive nil                ; prevent really unintuitive undo behavior
    load-prefer-newer t                      ; load newest file version available
    user-full-name "Marcel Fries"            ; it's me
    )

Read environment variables from the shell

  (use-package exec-path-from-shell
    :config
    (exec-path-from-shell-initialize))

Show the current filename in titlebar

  (setq-default frame-title-format
                (list '((buffer-file-name " %f"
                                          (dired-directory
                                           dired-directory
                                           (revert-buffer-function " %b"
                                                                   ("%b - Dir:  " default-directory)))))))

Default encoding

  (prefer-coding-system 'utf-8)

Shorten "yes or no" questions

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

Always highlight the current line

(global-hl-line-mode t)

Always highlight matching braces

(show-paren-mode t)

Allow selection override

(delete-selection-mode t)

Behave like a normal text editor

(cua-mode t)

Remember where we are

(save-place-mode)

Set cursor and indet mode

  (setq-default
    cursor-type 'bar
    indent-tabs-mode nil
    cursor-in-non-selected-windows nil)

Set default column width

(set-fill-column 95)

Hooks

Remove trailing whitespace on file close

  (add-hook 'before-save-hook 'delete-trailing-whitespace)

Elisp

Some customization for writing elisp

  (defun my-elisp-mode-hook ()
    "My elisp customizations."
    (electric-pair-mode 1)
    (add-hook 'before-save-hook 'check-parens nil t)
    (auto-composition-mode nil))

  (add-hook 'emacs-lisp-mode-hook 'my-elisp-mode-hook)

Global Key Bindings

  (bind-key "C-x k"      'kill-buffer-with-prejudice)
  (bind-key "C-c 5"      'query-replace-regexp) ;; stupid vestigial binding
  (bind-key "M-/"        'hippie-expand)
  (bind-key "C-c \\"     'align-regexp)
  (bind-key "C-c m"      'compile)
  (bind-key "C-c 3"      'split-right-and-enter)
  (bind-key "C-c 2"      'split-below-and-enter)
  (bind-key "M-p"        'switch-to-previous-buffer)
  (bind-key "C-c /"      'comment-or-uncomment-region)
  (bind-key "C-c x"      'ESC-prefix)
  (bind-key "M-i"        'delete-indentation)
  (bind-key "C-+"        'text-scale-increase)
  (bind-key "C--"	   'text-scale-decrease)
  (bind-key "C-<"        'beginning-of-buffer)
  (bind-key "C->"        'end-of-buffer)
  (bind-key "C-x C-b"    'ibuffer) ;; buffer-list is not a good default

Unbind some default key bindings

  (unbind-key "C-<tab>") ;; prevent switching to tab mode randomly
  (unbind-key "C-h n")   ;; I have never wanted to see emacs news ever
  (unbind-key "C-h C-n") ;; why on earth is it bound to two keybindings??
  (unbind-key "C-x C-d") ;; list-directory is utterly useless given the existence of dired
  (unbind-key "C-x C-r") ;; as is find-file-read-only

Load custom.el

Load a custom file from the emacs home dir. This file is specific to the maschine emacs runs on. It conatins customizations and file locations that are maschine dependend.

  (setq custom-file "~/.emacs.d/custom.el")
  (load custom-file 'noerror)