Wolfe's Literate Emacs Config

Table of Contents

1 About

Build Status

This literate config is best read here or in emacs. This page is generated and kept up to date using a combination of travis ci and ReadTheOrg. If you want to see the script that travis uses here is the bash script it runs and this is the .el file that it runs through emacs to generate the html page (this was mostly stolen from IvanMalison).

Included in this section is also my export headers. These are responsible for including the ReadTheOrg theme as well as some metadata and options like title, author, table of contents etc. If you wish to see the headers I'm using, this is the raw org file.

2 Variables

Variables come at the beginning so that they're consistently available. If you don't care about these click here to skip over them.

2.1 Config Name

(defvar wolfe/literate-config-name "README.org"
  "The name of my literate config")

2.2 Init File

(defvar wolfe/init-file (concat user-emacs-directory wolfe/literate-config-name)
  "The path to my literate config file")

2.3 Linux Check

(defvar wolfe/linux? (eq system-type 'gnu/linux)
  "Are we on linux?")

2.4 Windows Check

(defvar wolfe/windows? (eq system-type 'windows-nt)
    "Are we on windows?")

2.5 Org Ellipsis

(defvar wolfe/org-ellipsis
  (if (display-graphic-p)
      "⤵"
    "...")
  "The indicates if an `org-mode' tree can be expanded")

2.6 Project Path

(defvar wolfe/project-path
  (cond
   (wolfe/linux? "~/Projects/")
   (wolfe/windows? "C:/dev/")
   (:else nil))
  "Path to my projects directory")

2.7 Dropbox Path

(defvar wolfe/org-dropbox-path
  (cond
   (wolfe/linux?
    "~/Dropbox/org/")
   (wolfe/windows?
    "C:\\Users\\Josh\\Dropbox\\org\\")
   (:else nil))
  "Path to my org files inside dropbox")

2.8 Theme Checks

(defvar wolfe/using-dark t
  "Indicates whether we're using my dark theme")
(defvar wolfe/using-light nil
  "Indicates whether we're using my light theme")

2.9 Lisp Path Location

(defvar wolfe/lisp-dir-path "~/.emacs.d/lisp/"
  "Path to my custom lisp files")

2.10 Highlight Escapes Modes

(defvar wolfe/highlight-escapes-mode-list '(python-mode
                                            c-mode
                                            c++-mode
                                            web-mode)
  "List of modes to highlight escape characters in")

2.11 IRC Info Path

(defvar wolfe/irc-info-path "~/.ircinfo.gpg"
  "Location of the GPG encrypted file that has my irc login info")

3 Startup

My graphical settings change depending on whether I'm in terminal and if a command line flag (-light) was specified.

3.1 Theme Setup

This should be run regardless of whether I'm in terminal vs gui or dark vs light.

(setq custom-theme-directory "~/.emacs.d/themes")

(defmacro check-and-remove-command-line-arg (argument)
  "Checks `command-line-args' for argument and removes it if found returning t or nil"
  (if (member argument command-line-args)
      (progn
        (setq command-line-args (delete argument command-line-args))
        t)
    nil))

(let ((result (check-and-remove-command-line-arg "-light")))
  (setq wolfe/using-light result)
  (setq wolfe/using-dark (not result)))

3.2 Dark

Configuration for my dark theme base16 default dark which is loaded by default.

3.2.1 Common

(defun wolfe/dark-setup ()
  (use-package base16-theme
    :config
    (load-theme 'base16-default-dark t)

    (if (display-graphic-p)
        (wolfe/dark-gui-setup)
      (wolfe/dark-term-setup))))

3.2.2 Graphical

(defun wolfe/dark-gui-setup ()
    (defvar my/base16-colors base16-default-dark-colors)
    (setq evil-emacs-state-cursor   `(,(plist-get my/base16-colors :base0D) box)
          evil-insert-state-cursor  `(,(plist-get my/base16-colors :base0D) bar)
          evil-motion-state-cursor  `(,(plist-get my/base16-colors :base0E) box)
          evil-normal-state-cursor  `(,(plist-get my/base16-colors :base07) box)
          evil-replace-state-cursor `(,(plist-get my/base16-colors :base08) bar)
          evil-visual-state-cursor  `(,(plist-get my/base16-colors :base09) box))
    (set-face-attribute 'fringe nil :background nil)

  (custom-set-faces
   '(region ((t (:background "gray19"))))
   '(org-block ((t (:foreground "#d8d8d8"))))
   '(org-done ((t (:box (:line-width 1) :weight bold))))
   '(org-level-1 ((t (:inherit outline-1 :height 1.3))))
   '(org-todo ((t (:box (:line-width 1) :weight bold))))))

3.2.3 Terminal

(defun wolfe/dark-term-setup ()
  (setq nlinum-format "%d ")
  (custom-set-faces
   '(line-number ((t (:background "color-18" :foreground "brightblack"))))
   '(ivy-current-match ((t (:background "color-18" :foreground "color-16"))))
   '(linum ((t (:background "color-18"))))
   '(region ((t :background "color-19")))
   '(mode-line ((t (:background "color-19" :foreground "brightblue" :box nil))))
   '(mode-line-inactive
     ((t (:background "color-18" :foreground "color-244"))))))

3.3 Light

Configuration for my light theme leuven. This is only loaded when the -light flag is specified on the command line.

3.3.1 Common

(defun wolfe/light-setup ()
  (use-package leuven-theme
    :config
    (custom-set-faces
     '(ivy-subdir ((t (:background "gray88")))))
    (load-theme 'leuven t)))

3.4 Display check

This checks which setup we're in and calls the appropriate function above.

(if wolfe/using-light
    (wolfe/light-setup)
  (wolfe/dark-setup))

4 General Settings

Basic settings I can't really live without.

4.1 Load Path

Recursively add ~/.emacs.d/lisp/ to my load path.

(add-to-list 'load-path wolfe/lisp-dir-path)
(let ((default-directory wolfe/lisp-dir-path))
  (normal-top-level-add-subdirs-to-load-path))

4.2 Splash and Startup

This makes sure I'm presented with a nice blank *scratch* buffer when emacs starts up.

(setq inhibit-splash-screen t
      inhibit-startup-message t
      initial-scratch-message "") ; No scratch text
(defun display-startup-echo-area-message ()
  (message "Welcome to the church of GNU/Emacs"))

4.3 Graphics

4.3.1 Bars

I don't really want to have to look at menu bars that I'm not going to use

(tool-bar-mode -1) ; No toolbar
(scroll-bar-mode -1) ; Hide scrollbars
(menu-bar-mode -1) ; No menubar

4.3.2 Fonts

Quick macro that tries to load the font. If it loads it return t so we know not to try and load anything else if it returns nil then we'll try a different font.

(defmacro load-font-if-exists (family size)
  (if (member family (font-family-list)) ; Set default font
      (progn
        (let ((font-and-size (format "%s-%s" family size)))
          (add-to-list 'default-frame-alist `(font . ,font-and-size))
          (set-face-attribute 'default t :font font-and-size))
        t)
    nil))

I like Inconsolata-dz a bit more than Inconsolata so use it if installed otherwise fall back to regular Inconsolata.

(unless (load-font-if-exists "Inconsolata-dz" 17)
  (load-font-if-exists "Inconsolata" 17))

Force Fira Code for all UTF-8 symbols.

(let ((utf8-font "Fira Code"))
  (set-fontset-font "fontset-startup" '(#x000000 . #x3FFFFF) utf8-font)
  (set-fontset-font "fontset-default" '(#x000000 . #x3FFFFF) utf8-font)
  (set-fontset-font "fontset-standard" '(#x000000 . #x3FFFFF) utf8-font))

Make sure that UTF-8 is used everywhere.

(set-terminal-coding-system  'utf-8)
(set-keyboard-coding-system  'utf-8)
(set-language-environment    'utf-8)
(set-selection-coding-system 'utf-8)
(setq locale-coding-system   'utf-8)
(prefer-coding-system        'utf-8)
(set-input-method nil)

4.3.3 Pretty Symbols

In emacs 24.4 we got prettify-symbols-mode which replaces things like lambda with λ. This can help make the code easier to read. The inhibit-compacting-font-caches stops garbage collect from trying to handle font caches which makes things a lot faster and saves us ram.

(setq prettify-symbols-unprettify-at-point 'right-edge)
(setq inhibit-compacting-font-caches t)
4.3.3.1 Global

These symbols are the basics that I would like enabled for all prog-mode modes. This function can be called by the mode specific hook to push the defaults.

(defun wolfe/pretty-symbol-push-default ()
  (push '("!=" . ?≠) prettify-symbols-alist)
  (push '("<=" . ?≤) prettify-symbols-alist)
  (push '(">=" . ?≥) prettify-symbols-alist)
  (push '("=>" . ?⇒) prettify-symbols-alist))

Now apply the default to some modes I don't want anything special in.

(mapc
 (lambda (hook)
   (add-hook 'hook (lambda () (wolfe/pretty-symbol-push-default))))
 '(c-mode))
4.3.3.2 Python
(add-hook 'python-mode-hook
          (lambda ()
            (wolfe/pretty-symbol-push-default)
            (push '("def"    . ?ƒ) prettify-symbols-alist)
            (push '("sum"    . ?Σ) prettify-symbols-alist)
            (push '("**2"    . ?²) prettify-symbols-alist)
            (push '("**3"    . ?³) prettify-symbols-alist)
            (push '("None"   . ?∅) prettify-symbols-alist)
            (push '("in"     . ?∈) prettify-symbols-alist)
            (push '("not in" . ?∉) prettify-symbols-alist)
            (push '("return" . ?➡) prettify-symbols-alist)
            (prettify-symbols-mode t)))
4.3.3.3 Lisp
(add-hook 'emacs-lisp-mode-hook
          (lambda ()
            (wolfe/pretty-symbol-push-default)
            (push '("defun"    . ?ƒ) prettify-symbols-alist)
            (push '("defmacro" . ?μ) prettify-symbols-alist)
            (push '("defvar"   . ?ν) prettify-symbols-alist)
            (prettify-symbols-mode t)))
4.3.3.4 Go
(add-hook 'go-mode-hook
          (lambda ()
            (wolfe/pretty-symbol-push-default)
            (push '("func"    . ?ƒ) prettify-symbols-alist)
            (push '(":="    . ?←) prettify-symbols-alist)
            (prettify-symbols-mode t)))

4.3.4 Column Marker

(use-package column-marker
  :ensure nil
  :config
  (add-hook 'prog-mode-hook (lambda () (interactive) (column-marker-1 81)))
  (custom-set-faces
   '(column-marker-1 ((t (:background "dim gray"))))))

4.3.5 Highlight Escape Characters

This defines 4 new faces and the appropriate regexps that highlight them and maps them to all the modes in wolfe/highlight-escapes-mode-list.

(defface wolfe/backslash-escape-backslash-face
  '((t :inherit font-lock-regexp-grouping-backslash))
  "Face for the back-slash component of a back-slash escape."
  :group 'font-lock-faces)

(defface wolfe/backslash-escape-char-face
  '((t :inherit font-lock-regexp-grouping-construct))
  "Face for the charcter component of a back-slash escape."
  :group 'font-lock-faces)

(defface wolfe/format-code-format-face
  '((t :inherit font-lock-regexp-grouping-backslash))
  "Face for the % component of a printf format code."
  :group 'font-lock-faces)

(defface wolfe/format-code-directive-face
  '((t :inherit font-lock-regexp-grouping-construct))
  "Face for the directive component of a printf format code."
  :group 'font-lock-faces)

(mapc
 (lambda (mode)
   (font-lock-add-keywords
    mode
    '(("\\(\\\\\\)." 1 'wolfe/backslash-escape-backslash-face prepend)
      ("\\\\\\(.\\)" 1 'wolfe/backslash-escape-char-face      prepend)
      ("\\(%\\)."    1 'wolfe/format-code-format-face         prepend)
      ("%\\(.\\)"    1 'wolfe/format-code-directive-face      prepend))))
 wolfe/highlight-escapes-mode-list)

4.4 Personal Defaults

Nothing to crazy here just the type of behaviour I personally expect as default.

(show-paren-mode t) ; Highlights matching parens
(fset 'yes-or-no-p 'y-or-n-p) ; y/n instead of yes/no
(blink-cursor-mode -1) ; No need to flash the cursor
(column-number-mode t) ; Show column in mode-line
(delete-selection-mode 1) ; Replace selection on insert
(setq-default truncate-lines t ; Don't wrap
              indent-tabs-mode nil)
(setq vc-follow-symlinks t ; Always follow symlinks
      tags-revert-without-query t ; Don't ask to reload TAGS file
      echo-keystrokes 0.5
      custom-file "~/.emacs.d/custom.el" ; Set custom file and don't load it
      source-directory "~/Projects/emacs/")

4.5 Misc

4.5.1 Vim Scrolloff

This makes scrolling gradual rather than by half page. I find that the half page scroll really makes me lose where I am in the file so here I make sure to scroll one line at a time. In addition I want to keep what I'm working on centered so I start scrolling when the cursor is 10 lines away from the margin.

This behaviour in general emulates the scrolloff option in vim.

(setq scroll-margin 10
      scroll-step 1
      scroll-conservatively 10000
      scroll-preserve-screen-position 1)

4.5.2 Shell Tweaks

(setq explicit-shell-file-name
      (if (file-readable-p "/usr/bin/zsh") "/usr/bin/zsh" "/bin/bash"))
(when (eq system-type 'windows-nt)
  (setq explicit-shell-file-name "cmdproxy.exe"))

4.6 Mode Line

If we're in GUI emacs we make sure to use powerline otherwise we use a custom mode line configuration.

(if (display-graphic-p)
    (use-package powerline
      :init
      (defadvice powerline-major-mode (around delight-powerline-major-mode activate)
        (let ((inhibit-mode-name-delight nil))
          ad-do-it))

      :config
      (setq powerline-arrow-shape 'curve
            powerline-display-buffer-size nil
            powerline-display-mule-info nil)
      (powerline-default-theme)
      (remove-hook 'focus-out-hook 'powerline-unset-selected-window)
      (setq powerline-height 24))

  (setq-default mode-line-format
   (list
    " "
    ;; is this buffer read-only?
    '(:eval (when buffer-read-only
              (propertize "RO"
                          'face 'font-lock-type-face
                          'help-echo "Buffer is read-only")))

    ;; was this buffer modified since the last save?
    '(:eval (when (buffer-modified-p)
              (propertize "M"
                          'face 'font-lock-warning-face
                          'help-echo "Buffer has been modified")))

    " "
    ;; the buffer name; the file name as a tool tip
    '(:eval (propertize "%b " 'face 'font-lock-keyword-face
                        'help-echo (buffer-file-name)))


    ;; the current major mode for the buffer.
    "["

    '(:eval (propertize (format-mode-line mode-name) 'face '(:family "Arial")
                        'help-echo buffer-file-coding-system))
    '(:eval (propertize (format-mode-line minor-mode-alist)
                        'face '(:family "Arial")))
    "]             "

    ;; line and column
    "(" ;; '%02' to set to 2 chars at least; prevents flickering
    (propertize "%02l" 'face 'font-lock-type-face) ","
    (propertize "%02c" 'face 'font-lock-type-face)
    ") "

    ;; relative position, size of file
    "["
    (propertize "%p" 'face 'font-lock-constant-face) ;; % above top
    "/"
    (propertize "%I" 'face 'font-lock-constant-face) ;; size
    "] "

    ;; add the time, with the date and the emacs uptime in the tooltip
    '(:eval (propertize (format-time-string "%H:%M")
                        'help-echo
                        (concat (format-time-string "%c; ")
                                (emacs-uptime "Uptime:%hh"))))
    )))

4.7 Line Numbers

Vim-like relative line numbering. If we're on the latest versions of emacs (i.e. 26.0.50 or higher) then we should use the native line numbering otherwise we fall back to nlinum-relative.

(if (fboundp 'display-line-numbers-mode)
    (progn
      (setq display-line-numbers 'relative)
      (add-hook 'prog-mode-hook 'display-line-numbers-mode))
  (progn
    (use-package nlinum-relative
      :config
      (nlinum-relative-setup-evil)
      (setq nlinum-relative-redisplay-delay 0.25)
      (setq nlinum-relative-current-symbol "")
      (add-hook 'prog-mode-hook 'nlinum-relative-mode))))

5 Functions

5.1 Face Under Point

Returns the font lock face that's under the cursor.

(defun what-face (pos)
  (interactive "d")
  (let ((face (or (get-char-property (point) 'read-face-name)
                  (get-char-property (point) 'face))))
    (if face (message "Face: %s" face) (message "No face at %d" pos))))

5.2 Compile Project

Compiles the project without a prompt.

(defun wolfe/compile-no-prompt ()
  (interactive)
  (let ((compilation-read-command nil))
    (compile (eval compile-command))))

5.3 Compile Dotfiles

Compiles all el files in the ~/.emacs.d directory.

(defun wolfe/compile-dot-emacs ()
  "Byte-compile dotfiles."
  (interactive)
  (byte-recompile-directory user-emacs-directory 0))
(defun wolfe/clear-all-elc ()
  (interactive)
  (shell-command "find ~/.emacs.d/ -name \"*.elc\" -type f -delete"))
(defun wolfe/remove-elc-on-save ()
  "If you're saving an emacs-lisp file, likely the .elc is no longer valid."
  (add-hook 'after-save-hook
            (lambda ()
              (if (file-exists-p (concat buffer-file-name "c"))
                  (delete-file (concat buffer-file-name "c"))))
            nil t))
(add-hook 'emacs-lisp-mode-hook 'wolfe/remove-elc-on-save)

5.4 Find Tags

Looks up tag under point.

(defun wolfe/find-tag ()
  "Jump to the tag at point without prompting"
  (interactive)
  (find-tag (find-tag-default)))
(defun wolfe/create-tags ()
  "Create the tags table"
  (interactive)
  (save-window-excursion (shell-command "etags -R -o ETAGS *")))
(defadvice xref-find-definitions (around refresh-etags activate)
  "Rerun etags and reload tags if tag not found and redo find-tag.
   If buffer is modified, ask about save before running etags."
  (condition-case err
      ad-do-it
    (error (and (buffer-modified-p) (not (ding))
                (save-buffer))
           (save-window-excursion (shell-command "etags -R *"))
           ad-do-it)))

5.5 Terminal Suspend

Fixes C-z in terminal.

(defun wolfe/controlz ()
  (interactive)
  (when (eq (display-graphic-p) nil)
    (suspend-frame)))

5.6 Dropbox

Utility functions for finding Dropbox directories/files.

(defun wolfe/org-open (name)
  "Opens the file in the dropbox path"
  (interactive)
  (evil-buffer-new nil (concat wolfe/org-dropbox-path name ".org")))
(defun wolfe/dropbox-start ()
  (interactive)
  (if (eq nil (file-exists-p "/virtual/wolfejos/dropbox/.dropbox-dist"))
      (call-process-shell-command "(python ~/.emacs.d/dropbox.py start -i&)")
    (call-process-shell-command "(python ~/.emacs.d/dropbox.py start&)")))
(defun wolfe/dropbox-stop ()
  (interactive)
  (call-process-shell-command "python ~/.emacs.d/dropbox.py stop&"))

5.7 Reload

For reloading init.el file without restarting.

(defun wolfe/load-init ()
  "Reloads init file"
  (interactive)
  (load-file "~/.emacs.d/init.el"))

5.8 Narrowing

Better narrowing.

(defun narrow-or-widen-dwim (p)
  "Widen if buffer is narrowed, narrow-dwim otherwise.
Dwim means: region, org-src-block, org-subtree, or
defun, whichever applies first. Narrowing to
org-src-block actually calls `org-edit-src-code'.

With prefix P, don't widen, just narrow even if buffer
is already narrowed."
  (interactive "P")
  (declare (interactive-only))
  (cond ((and (buffer-narrowed-p) (not p)) (widen))
        ((region-active-p)
         (narrow-to-region (region-beginning)
                           (region-end)))
        ((derived-mode-p 'org-mode)
         ;; `org-edit-src-code' is not a real narrowing
         ;; command. Remove this first conditional if
         ;; you don't want it.
         (cond ((ignore-errors (org-edit-src-code) t)
                (delete-other-windows))
               ((ignore-errors (org-narrow-to-block) t))
               (t (org-narrow-to-subtree))))
        ((derived-mode-p 'latex-mode)
         (LaTeX-narrow-to-environment))
        (t (narrow-to-defun))))

(defun wolfe/man ()
  (if (executable-find "man")
      (man (word-at-point))
    (woman)))

5.9 Open C# Project File

This function prompts for a file. It then opens that file and looks for a src/ directory above it. The dir can be any number of levels higher. In that folder it looks for a C# .sln file and starts the an omnisharp server for that project.

(defun wolfe/csharp-project ()
  (interactive)
  (setq path (read-file-name "File: " wolfe/project-path))
  (setq split-path (split-string path "/"))
  (if (member "src" split-path)
      (catch 'loop
        (dolist (item (reverse split-path))
          (if (string-equal item "src")
              (throw 'loop nil)
            (delete item split-path)))
        (message "src/ directory not found")))

  (if (or (equal '("c:") split-path) (equal '() split-path))
      (message "Could not find src directory for specified project")
    (progn
      (omnisharp-start-omnisharp-server (mapconcat 'identity split-path "/"))
      (find-file path))))

5.10 Hot Expand

Is used in one of my hydras wolfe/hydra-org-expand. For inserting org-templates.

(defun hot-expand (str &optional additional-text)
  "Expand org template."
  (insert str)
  (org-try-structure-completion)
  (when additional-text
    (insert additional-text)
    (forward-line)))

5.11 Ag Project If In Project

If we're inside of a projectile project we'll use projectile-ag to search the project otherwise just normal ag frow our working directory does the job.

(defun wolfe/ag-try-project ()
  (interactive)
  (if (projectile-project-p)
      (call-interactively 'projectile-ag)
    (call-interactively 'ag)))

5.12 Projectile Invalidate From List

Select project from list of projectile projects to invalidate.

(defun wolfe/projectile-invalidate-list ()
  (interactive)
  (projectile-invalidate-cache t))

5.13 User Pass Tupple

Uses GPG to decrypt file and returns a list of the contents split on spaces.

(defun wolfe/get-user-pass (file)
  (split-string
   (car (last (split-string
               (shell-command-to-string (concat "gpg --output - --decrypt "
                                                (expand-file-name file)))
               "[|\n]" t "[     \n]"))) " "))

5.14 Ag Kill Buffers and Close Window

Kill all the open ag buffers and delete the window I'm in. This is bound in my ag config in ag-mode-map so it will close the current ag window and all the buffers.

(defun wolfe/ag-kill-buffers-and-window ()
  (interactive)
  (ag-kill-buffers)
  (delete-window))

5.15 Org Tree Slides Set Transient Map

This function once called will keep a transient map active until wolfe--enable-transient-map is set to nil at which point it will unbind the variable. This is used with org-tree-slide-mode to add custom bindings regardless of the mode.

(defun wolfe/org-tree-set-transient-map ()
  (interactive)
  (if wolfe--enable-transient-map
      (let ((map (make-sparse-keymap)))
        (define-key map (kbd "<right>") 'org-tree-slide-move-next-tree)
        (define-key map (kbd "<left>")  'org-tree-slide-move-previous-tree)
        (define-key map (kbd "<up>")    'org-tree-slide-content)
        (define-key map (kbd "<down>")  'org-tree-slide-display-header-toggle)
        (set-transient-map map nil 'wolfe/org-tree-set-transient-map))
    (makeunbound wolfe--enable-transient-map)))

6 Org Mode

6.1 General

Setup some basic quality of life org settings.

(setq org-pretty-entities t
      org-src-fontify-natively t
      org-src-tab-acts-natively t
      org-src-window-setup 'current-window
      org-fontify-whole-heading-line t
      org-fontify-done-headline t
      org-fontify-quote-and-verse-blocks t
      org-highlight-latex-and-related '(latex)
      org-log-done 'time
      org-agenda-use-time-grid nil
      org-agenda-skip-deadline-if-done t
      org-agenda-skip-scheduled-if-done t
      org-ellipsis wolfe/org-ellipsis)

(org-babel-do-load-languages
 'org-babel-load-languages
 '((shell . t)
   (  dot . t)))

(global-set-key "\C-cl" 'org-store-link)

;; ispell ignores SRC blocks
(add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_SRC" . "#\\+END_SRC"))
(add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_LATEX" . "#\\+END_LATEX"))

;; Refresh images after executing a src block
(add-hook 'org-babel-after-execute-hook
          '(lambda ()
             (when org-inline-image-overlays
               (org-redisplay-inline-images))))

;; Open PDFs with zathura
(add-hook 'org-mode-hook
          '(lambda ()
             (setq org-file-apps
                   (append '(("\\.pdf\\'" . "zathura \"%s\"")) org-file-apps))))

6.2 Bullets

Replaces the asterisks with nice UTF-8 bullets.

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

6.3 Agenda

Setup org agenda for managing my life.

(use-package org-agenda
  :ensure nil
  :bind (("C-c a" . org-agenda)
         :map org-agenda-mode-map
         ("j" . org-agenda-next-item)
         ("k" . org-agenda-previous-item))
  :config
  ;; Formats the agenda into nice columns
  (setq org-agenda-prefix-format
        '((agenda . " %i %-12t% s %-12(car (last (org-get-outline-path)))")
          (timeline . "  % s")
          (todo . " %i %-12:c")
          (tags . " %i %-12:c")
          (search . " %i %-12:c")))

  ;; Sets location of org files
  (setq org-agenda-files `(,(concat wolfe/org-dropbox-path "everything.org")))
  (setq browse-url-browser-function 'browse-url-chromium))

6.4 Export

Setup html for syntax highlighting on export and add the apppropriate minted package for PDF export.

(use-package htmlize)

(require 'ox-latex)
(add-to-list 'org-latex-packages-alist '("" "minted"))
(setq org-export-allow-bind-keywords t
      org-latex-listings 'minted)
(setq org-latex-pdf-process
      '("pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"
        "pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"
        "pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"))

6.5 Org Tree Slide

Presentation mode that runs from within an org document. I add a custom hook for a function that repeatedly creates a transient map replacing the controls regardless of my evil mode.

(use-package org-tree-slide
  :config
  (add-hook 'org-tree-slide-mode-hook
            (lambda ()
              (if org-tree-slide-mode
                  ;; When mode is enabled
                  (progn (setq org-hide-emphasis-markers t
                               wolfe--enable-transient-map t)
                         (wolfe/org-tree-set-transient-map))
                ;; When mode is disabled
                (setq org-hide-emphasis-markers nil
                      wolfe--enable-transient-map nil)))))

7 Keymaps

7.1 Hydra

Customizable popup menus.

(use-package hydra)

7.1.1 Major Modes

7.1.1.1 C#
(setq wolfe/hydra-csharp
      (defhydra hydra-csharp (:color blue :columns 4)
        "Omnisharp"
        ("d" omnisharp-go-to-definition              "Goto definition")
        ("D" omnisharp-go-to-definition-other-window "Pop-open definition")
        ("u" omnisharp-find-usages                   "Find usages")
        ("r" omnisharp-rename                        "Rename symbol")
        ("R" omnisharp-reload-solution               "Reload solution")
        ("i" omnisharp-code-format-region            "Indent region")
        ("I" omnisharp-code-format-entire-file       "Indent entire file")
        ))
7.1.1.2 Python
(setq wolfe/hydra-python
      (defhydra hydra-python (:color blue :columns 4)
        "Python"
        ("i" elpy-importmagic-fixup "Importmagic fixup")
        ("d" elpy-goto-definition   "Goto definition")
        ("r" elpy-multiedit-python-symbol-at-point   "Rename symbol")
        ("f" elpy-format-code   "Format code")
        ))
7.1.1.3 Org Mode
(setq wolfe/hydra-org
      (defhydra hydra-org (:color blue)
        "Org Mode"
        ("t" (funcall wolfe/hydra-org-expand) "Expand template")))
7.1.1.4 Org Templates
(setq wolfe/hydra-org-expand
      (defhydra hydra-org-template (:color blue :hint nil)
        "
        _c_enter  _q_uote    _L_aTeX:
        _l_atex   _e_xample  _i_ndex:
        _a_scii   _v_erse    _I_NCLUDE:
        _s_rc     _t_angle   _H_TML:
        _h_tml    _d_ot src  _A_SCII:
        "
        ("s" (hot-expand "<s"))
        ("e" (hot-expand "<e"))
        ("q" (hot-expand "<q"))
        ("v" (hot-expand "<v"))
        ("t" (hot-expand "<s" "emacs-lisp :tangle yes"))
        ("d" (hot-expand "<s" "dot :file TMP.png :cmdline -Kdot -Tpng"))
        ("c" (hot-expand "<c"))
        ("l" (hot-expand "<l"))
        ("h" (hot-expand "<h"))
        ("a" (hot-expand "<a"))
        ("L" (hot-expand "<L"))
        ("i" (hot-expand "<i"))
        ("I" (hot-expand "<I"))
        ("H" (hot-expand "<H"))
        ("A" (hot-expand "<A"))))

7.1.2 Minor Modes

7.1.2.1 Projectile
(setq wolfe/hydra-projectile
      (defhydra hydra-projectile (:color blue :columns 4)
        "Projectile"
        ("f" counsel-projectile-find-file        "Find File")
        ("s" counsel-projectile-switch-project   "Switch Project")
        ("k" projectile-kill-buffers             "Kill Buffers")
        ("c" projectile-invalidate-cache         "Clear Cache")

        ("d" counsel-projectile-find-dir         "Find Directory")
        ("o" projectile-multi-occur              "Multi Occur")
        ("P" projectile-clear-known-projects      "Clear Projects")
        ("C" wolfe/projectile-invalidate-list    "Clear A Cache")
        ))
7.1.2.2 Jira
(setq wolfe/hydra-jira
      (defhydra hydra-jira (:color blue :columns 4)
        "Jira"
        ("p" org-jira-get-projects             "Get Projects")
        ("b" org-jira-browse-issue             "Browse Issue")
        ("g" org-jira-get-issues               "Get Issues")
        ("u" org-jira-update-issue             "Update Issue")

        ("p" org-jira-progress-issue           "Update Issue Progress")
        ("a" org-jira-assign-issue             "Assign Issue")
        ("r" org-jira-refresh-issue            "Refresh Issue")
        ("R" org-jira-refresh-issues-in-buffer "Refresh Issues in Buffer")

        ("c" org-jira-create-issue             "Create Issue")
        ("y" org-jira-copy-current-issue-key   "Copy Current Issue Key")
        ("s" org-jira-create-subtask           "Create Subtask")
        ("G" org-jira-get-subtasks             "Get Subtasks")

        ("U" org-jira-update-comment           "Update Comment")
        ("t" org-jira-todo-to-jira             "Todo to Jira")
        ("O"  (funcall wolfe/hydra-org-expand)  "Org Hydra")))

7.1.3 Default

(setq wolfe/hydra-default
      (defhydra hydra-default (:color blue)
        "Default"
        ("o" (funcall wolfe/hydra-org) "Org Mode")
        ("p" (funcall wolfe/hydra-python) "Python Mode")
        ("#" (funcall wolfe/hydra-csharp) "C# Mode")))

7.1.4 Selector

(defun wolfe/hydra-selector ()
  (cond
   ((derived-mode-p 'csharp-mode) wolfe/hydra-csharp)
   ((derived-mode-p 'python-mode) wolfe/hydra-python)
   ((bound-and-true-p org-jira-mode) wolfe/hydra-jira)
   ((derived-mode-p 'org-mode) wolfe/hydra-org)
   (:else wolfe/hydra-default)))

7.2 Evil & General

7.2.1 General

(use-package general)

7.2.2 Evil

(use-package evil
  :demand
  :init
  (setq evil-want-C-u-scroll t) ; Unbind <C-u> for evil mode's use
  (setq evil-want-C-i-jump nil)
  :config
  (evil-mode t)
  (setq evil-split-window-below t
        evil-vsplit-window-right t
        evil-lookup-func #'wolfe/man)
  (setq-default evil-symbol-word-search t)
  (custom-set-variables '(evil-search-module (quote evil-search)))
  (evil-ex-define-cmd "re[load]" 'wolfe/load-init) ; Custom reload command
  (evil-ex-define-cmd "Q" 'save-buffers-kill-terminal) ; For typos
  (define-key evil-ex-map "e " 'counsel-find-file) ; Trigger file completion :e
  (global-unset-key (kbd "M-SPC")) ; Unbind secondary leader

  (general-create-definer wolfe/bind-leader
                          :keymaps 'global
                          :states '(normal insert visual emacs)
                          :prefix "SPC"
                          :non-normal-prefix "M-SPC")

  :general
  (:states 'motion
           "k" 'evil-previous-visual-line
           "j" 'evil-next-visual-line)

  (:states 'operator
           "k" 'evil-previous-line
           "j" 'evil-next-line)

  (:states 'visual
           "<" (lambda ()
                 (interactive)
                 (evil-shift-left (region-beginning) (region-end))
                 (evil-normal-state)
                 (evil-visual-restore))
           ">" (lambda ()
                 (interactive)
                 (evil-shift-right (region-beginning) (region-end))
                 (evil-normal-state)
                 (evil-visual-restore)))

  (:states 'normal
           "C-z"  'wolfe/controlz
           "C-l"  'evil-ex-nohighlight)

  (:states 'normal :prefix "g"
           "a" (lambda (beginning end)
                 (interactive "r")
                 (if (use-region-p)
                     (align beginning end)
                   (align-current)))
           "A" 'align-regexp)


  (wolfe/bind-leader
   "w"  'save-buffer
   "S"  'eval-buffer
   "s"  'eval-defun
   "b"  'mode-line-other-buffer
   "k"  'kill-buffer
   "m"  'ivy-switch-buffer
   "t"  'wolfe/find-tag
   "e"  'iedit-mode
   "c"  'wolfe/compile-no-prompt
   "n"  'narrow-or-widen-dwim
   "a"  'org-agenda
   "g"  'magit-status
   "f"  'wolfe/ag-try-project
   "''" 'org-edit-src-exit
   "#" 'wolfe/csharp-project
   "p" (lambda() (interactive) (funcall wolfe/hydra-projectile))
   ";" (lambda() (interactive) (save-excursion (end-of-line) (insert-char ?\;)))
   "id" (lambda() (interactive) (indent-region (point-min) (point-max)))
   "o"   (lambda() (interactive) (wolfe/org-open "everything"))
   "SPC" (lambda() (interactive) (funcall (wolfe/hydra-selector)))
   "init" (lambda() (interactive) (evil-buffer-new nil wolfe/init-file))))


7.2.3 Evil Surround

Tpope's surround

(use-package evil-surround
  :config
  (global-evil-surround-mode 1))

7.2.4 Evil Magit

(use-package evil-magit)

7.2.5 Evil Machit

(use-package evil-matchit
  :config
  (global-evil-matchit-mode 1))

7.2.6 Evil Visual Star

This allows me to easily start a * or # search from a visual selection.

(use-package evil-visualstar
  :config
  (global-evil-visualstar-mode))

8 Project Management

8.1 Ag

Emacs interface for ag

(use-package ag
  :bind (:map ag-mode-map
         ("Q" . wolfe/ag-kill-buffers-and-window)))

8.2 Magit

Magic git interface from within emacs

(use-package magit
  :defer t
  :config
  (setq magit-bury-buffer-function
        (lambda (con)
          (kill-buffer)
          (delete-window))))

8.3 Projectile

Project management

(use-package projectile
  :config
  (use-package counsel-projectile
    :config
    (counsel-projectile-on))
  (setq projectile-enable-caching t)
  (setq projectile-indexing-method 'alien)
  (setq projectile-globally-ignored-file-suffixes '(".dll" ".exe" ".o"))
  (setq projectile-globally-ignored-directories '(".git" "node_modules"))
  (projectile-mode))

9 Languages

9.1 Generic Web

(use-package web-mode
  :defer t
  :config
  (add-to-list 'auto-mode-alist '("\\.html\\'" . web-mode))
  (add-to-list 'auto-mode-alist '("\\.php\\'" . web-mode))
  (add-to-list 'auto-mode-alist '("\\.js\\'" . web-mode))

  (setq web-mode-enable-auto-closing t)
  (setq web-mode-enable-auto-opening t)
  (setq web-mode-enable-auto-indentation t))

(use-package json-mode)
(use-package company-restclient
  :after company
  :config
  (add-to-list 'company-backends 'company-restclient))

9.2 Javascript

(use-package company-tern
  :after company
  :config
  (add-to-list 'company-backends 'company-tern)
  (add-hook 'web-mode-hook 'tern-mode))

9.3 Lisp Family

(use-package parinfer
  :defer t
  :bind
  (("C-," . parinfer-toggle-mode))
  :init
  (setq
   parinfer-extensions '(defaults pretty-parens evil smart-tab smart-yank)
   parinfer-lighters '(" Φi" . " Φp"))
  (add-hook 'clojure-mode-hook     #'parinfer-mode)
  (add-hook 'emacs-lisp-mode-hook  #'parinfer-mode)
  (add-hook 'common-lisp-mode-hook #'parinfer-mode)
  (add-hook 'scheme-mode-hook      #'parinfer-mode)
  (add-hook 'lisp-mode-hook        #'parinfer-mode))

9.4 Racket

(use-package racket-mode
  :defer t)

9.5 Latex

(use-package latex-preview-pane
  :defer t
  :ensure f)

9.6 C/C++

(setq gdb-many-windows t
      gdb-show-main t
      company-clang-insert-arguments nil)

(use-package company-irony
  :after company
  :config
  (add-hook 'c++-mode-hook 'irony-mode)
  (add-hook 'c-mode-hook 'irony-mode)
  (eval-after-load 'company
    '(add-to-list 'company-backends 'company-irony)))

9.7 C#

(use-package omnisharp
  :after company
  :config
  (setq omnisharp-server-executable-path "C:/emacs/omnisharp/Omnisharp.exe")
  (add-hook 'csharp-mode-hook 'omnisharp-mode)
  (add-to-list 'company-backends 'company-omnisharp))

9.8 Python

(use-package elpy
  :after company
  :defer t
  :config
  (when (executable-find "ipython")
    (elpy-use-ipython))
  (elpy-enable))

9.9 Shell Scripts

(use-package company-shell
  :after company
  :config
  (add-to-list 'company-backends '(company-shell company-shell-env)))

9.10 Go

(use-package go-mode
  :config
  (add-hook 'go-mode-hook '(lambda () (setq tab-width 4))))
(use-package company-go
  :after company
  :config
  (add-to-list 'company-backends 'company-go))

9.11 Nim

(use-package nim-mode
  :defer t)

10 Utility

10.1 Ranger

(use-package ranger
  :config
  (setq ranger-cleanup-on-disable t)
  (ranger-override-dired-mode t))

10.2 Iedit

Edit all instances of a string

(use-package iedit
  :config
  (setq iedit-toggle-key-default nil))

10.3 Restclient

Postman inside of emacs.

(use-package restclient
  :defer t)

10.4 Rainbow Mode

Shows hex colors inline.

(use-package rainbow-mode
  :defer t)

10.5 Help Fns+

(use-package help-fns+)

10.6 Org Jira

(use-package org-jira
  :defer t
  :config
  (setq jiralib-url "https://indigoca.atlassian.net"))

10.7 Delight

(use-package delight
  :config
  (delight '((emacs-lisp-mode       "ξ" :major)
             (lisp-interaction-mode "λ" :major)
             (python-mode           "π" :major)
             (org-mode              "Ø" :major)
             (company-mode          " C" company)
             (ivy-mode              " ι" ivy)
             (projectile-mode       " ρ" projectile)
             (eldoc-mode            " ε" eldoc)
             (flycheck-mode         " ƒ" flycheck)
             (undo-tree-mode        ""   undo-tree)
             (auto-revert-mode      ""   autorevert))))

11 Completion

11.1 Ivy & Counsel

(use-package ivy
  :demand
  :bind (("M-x" . counsel-M-x)
         ("C-x C-f" . counsel-find-file)
         :map ivy-minibuffer-map
         ("TAB" . ivy-next-line)
         ("RET" . ivy-alt-done))
  :init
  (use-package smex)
  (use-package counsel)
  :config
  (setq ivy-re-builders-alist
        '((t . ivy--regex-ignore-order)))
  (setq ivy-wrap t)
  (ivy-mode 1)
  (eval-after-load "hydra" (use-package ivy-hydra)))

11.2 Swiper

(use-package swiper
  :bind (("C-s" . swiper)))

11.3 Company

Autocomplete engine

(use-package company
  :bind (:map company-active-map
         ("C-n" . company-select-next)
         ("C-p" . company-select-previous))
  :init
  (global-company-mode)
  :config
  (setq company-idle-delay 0) ; Delay to complete
  (setq company-minimum-prefix-length 1)
  (setq company-selection-wrap-around t) ; Loops around suggestions

  (if (display-graphic-p)
      (define-key company-active-map [tab] 'company-select-next)
    (define-key company-active-map (kbd "C-i") 'company-select-next))
(ignore-errors
  (require 'color)
  (let ((bg (face-attribute 'default :background)))
    (custom-set-faces
     `(company-tooltip ((t (:inherit default :background ,(color-lighten-name bg 2)))))
     `(company-scrollbar-bg ((t (:background ,(color-lighten-name bg 10)))))
     `(company-scrollbar-fg ((t (:background ,(color-lighten-name bg 5)))))
     `(company-tooltip-selection ((t (:inherit font-lock-function-name-face))))
     `(company-tooltip-common ((t (:inherit font-lock-constant-face))))))))

11.4 Flycheck Linting

On the fly syntax checking

(use-package flycheck
  :config
  (global-flycheck-mode)
  (with-eval-after-load 'flycheck
    (setq-default flycheck-disabled-checkers '(emacs-lisp-checkdoc))))

12 Misc

12.1 Email

(when (require 'mu4e nil 'noerror)
  (setq mu4e-msg2pdf "/usr/bin/msg2pdf")
  (setq
   ;; set mu4e as default mail client
   mail-user-agent 'mu4e-user-agent
   ;; root mail directory - can't be switched
   ;; with context, can only be set once
   mu4e-maildir "~/.mail"
   mu4e-attachments-dir "~/Downloads/Attachments"
   ;; update command
   mu4e-get-mail-command "mbsync -q -a"
   ;; update database every seven minutes
   mu4e-update-interval (* 60 7)
   ;; use smtpmail (bundled with emacs) for sending
   message-send-mail-function 'smtpmail-send-it
   ;; optionally log smtp output to a buffer
   smtpmail-debug-info t
   ;; close sent message buffers
   message-kill-buffer-on-exit t
   ;; customize list columns
   mu4e-headers-fields '((:flags . 4)
                         (:from . 20)
                         (:human-date . 10)
                         (:subject))
   ;; for mbsync
   mu4e-change-filenames-when-moving t
   ;; pick first context automatically on launch
   mu4e-context-policy               'pick-first
   ;; use current context for new mail
   mu4e-compose-context-policy       nil
   mu4e-confirm-quit                 nil)

  (global-set-key (kbd "<f12>") 'mu4e)
  (global-set-key (kbd "<C-f12>") 'mu4e-update-mail-and-index)

  (setq mu4e-contexts
        `(,(make-mu4e-context
            :name "gmail"
            :match-func (lambda(msg)
                          (when msg
                            (mu4e-message-contact-field-matches msg :to "@gmail.com")))
            :vars '(
                    ;; local directories, relative to mail root
                    (mu4e-sent-folder . "/gmail/[Gmail]/.Sent Mail")
                    (mu4e-drafts-folder . "/gmail/[Gmail]/.Drafts")
                    (mu4e-trash-folder . "/gmail/[Gmail]/.Trash")
                    (mu4e-refile-folder . "/gmail/[Gmail]/.All Mail")
                    ;; account details
                    (user-mail-address . "joshuafwolfe@gmail.com")
                    (user-full-name . "Josh Wolfe")
                    (mu4e-user-mail-address-list . ( "@gmail.com" ))
                    ;; gmail saves every outgoing message automatically
                    (mu4e-sent-messages-behavior . delete)
                    (mu4e-maildir-shortcuts . (("/gmail/INBOX" . ?j)
                                               ("/gmail/[Gmail]/.All Mail" . ?a)
                                               ("/gmail/[Gmail]/.Trash" . ?t)
                                               ("/gmail/[Gmail]/.Drafts" . ?d)))
                    ;; outbound mail server
                    (smtpmail-smtp-server . "smtp.gmail.com")
                    ;; outbound mail port
                    (smtpmail-smtp-service . 465)
                    ;; use ssl
                    (smtpmail-stream-type . ssl)
                    ;; the All Mail folder has a copy of every other folder's contents,
                    ;; and duplicates search results, which is confusing
                    (mue4e-headers-skip-duplicates . t)))))

  (use-package evil-mu4e))

12.2 IRC

My erc settings are pretty basic. I have the fill column recalculate on window resize and I put the scroll margin back to default so that my scrolloff settings don't mess with it.

(use-package erc
  :ensure nil
  :defer t
  :config
  (add-hook 'window-configuration-change-hook
            '(lambda ()
               (setq erc-fill-column (- (window-width) 2))))
  (add-hook 'erc-mode-hook
            '(lambda ()
                (setq-local scroll-margin 1)))

  (setq erc-rename-buffers t
        erc-interpret-mirc-color t
        erc-lurker-hide-list '("JOIN" "PART" "QUIT")
        erc-autojoin-channels-alist '(("freenode.net" "#emacs"))))

Simple function that pulls my credentials from a GPG encrypted file and connects to freenode providing a nick and password to verify my user.

(defun wolfe/irc ()
      (interactive)
      (let* ((tupple (wolfe/get-user-pass wolfe/irc-info-path))
             (user (car tupple))
             (pass (cadr tupple)))
        (erc
         :server "irc.freenode.net"
         :port 6667
         :nick user
         :password pass)))

12.3 Meme

Meme creator from within emacs… what more is there to say?

(use-package meme
  :ensure nil
  :commands (meme meme-file))

13 Backups

Stores all backups and temp files in ~/.bak.emacs/

(setq backup-by-copying t) ; Stop shinanigans with links
(setq backup-directory-alist '((".*" . "~/.bak.emacs/backup/")))
;; Creates directory if it doesn't already exist
(if (eq nil (file-exists-p "~/.bak.emacs/"))
    (make-directory "~/.bak.emacs/"))
;; Creates auto directory if it doesn't already exist
(if (eq nil (file-exists-p "~/.bak.emacs/auto"))
    (make-directory "~/.bak.emacs/auto"))
;; backup in one place. flat, no tree structure
(setq auto-save-file-name-transforms '((".*" "~/.bak.emacs/auto/" t)))

14 Testing

14.1 Org Project

(cond ((file-exists-p "~/Projects/org-project/")
       (load-file "~/Projects/org-project/org-project.el")
       (setq org-project-use-ag t))
      ((file-exists-p "C:/dev/SideProjects/org-project/")
       (load-file "C:/dev/SideProjects/org-project/org-project.el")
       (setq org-project-use-ag t)))

14.2 Extract Dates

(defun wolfe/extract-dates (file-path)
  "Parse through a file for a list of all the comments"
  (let (already-open
        buf
        start
        (comments '()))
    (setq already-open (find-buffer-visiting file-path)
          buf (find-file-noselect file-path))
    (with-current-buffer buf
      (goto-char (point-min))
      (while (setq start (text-property-any
                          (point) (point-max)
                          'face 'org-date))
        (goto-char start)
        (goto-char (next-single-char-property-change (point) 'face))
        (let ((item (string-trim (buffer-substring-no-properties start (point)))))
          (setq comments (cons item comments)))))
    (unless already-open (kill-buffer buf))
    (reverse comments)))