1 #+title: =aminb='s Literate Emacs Configuration
4 #+property: header-args :tangle yes
11 This org file is my literate configuration for GNU Emacs, and is
12 tangled to [[./init.el][init.el]]. Packages are installed and managed using
13 [[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of
14 many different people. Some of the configurations that I can remember
15 off the top of my head are:
17 - [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses
18 straight.el for managing packages
19 - [[https://github.com/dakra/dmacs][dakra/dmacs]]: literate Emacs configuration, using Borg for managing
21 - [[http://pages.sachachua.com/.emacs.d/Sacha.html][Sacha Chua's literate Emacs configuration]]
22 - [[https://github.com/dakrone/eos][dakrone/eos]]
23 - Ryan Rix's [[http://doc.rix.si/cce/cce.html][Complete Computing Environment]] ([[http://doc.rix.si/projects/fsem.html][about cce]])
24 - [[https://github.com/jwiegley/dot-emacs][jwiegley/dot-emacs]]: nix-based configuration
25 - [[https://github.com/wasamasa/dotemacs][wasamasa/dotemacs]]
26 - [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
28 I'd like to have a fully reproducible Emacs setup (part of the reason
29 why I store my configuration in this repository) but unfortunately out
30 of the box, that's not achievable with =package.el=, not currently
31 anyway. So, I've opted to use Borg. For what it's worth, I briefly
32 experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds
33 to my init time; which is unacceptable for me: I use Emacs as my
34 window manager (via EXWM) and coming from bspwm, I'm too used to
35 having fast startup times.
39 To use this config for your Emacs, first you need to clone this repo,
40 then bootstrap Borg, tell Borg to retrieve package submodules, and
41 byte-compiled the packages. Something along these lines should work:
43 #+begin_src sh :tangle no
44 git clone https://github.com/aminb/dotfiles ~/.emacs.d
51 * Contents :toc_1:noexport:
55 - [[#initial-setup][Initial setup]]
57 - [[#post-initialization][Post initialization]]
67 #+begin_src emacs-lisp :comments none
68 ;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
71 Enable =view-mode=, which both makes the file read-only (as a reminder
72 that =init.el= is an auto-generated file, not supposed to be edited),
73 and provides some convenient key bindings for browsing through the
78 #+begin_src emacs-lisp :comments none
79 ;; Copyright (C) 2018 Amin Bandali <amin@aminb.org>
81 ;; This program is free software: you can redistribute it and/or modify
82 ;; it under the terms of the GNU General Public License as published by
83 ;; the Free Software Foundation, either version 3 of the License, or
84 ;; (at your option) any later version.
86 ;; This program is distributed in the hope that it will be useful,
87 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
88 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
89 ;; GNU General Public License for more details.
91 ;; You should have received a copy of the GNU General Public License
92 ;; along with this program. If not, see <https://www.gnu.org/licenses/>.
97 #+begin_src emacs-lisp :comments none
100 ;; Emacs configuration of Amin Bandali, computer scientist and functional
103 ;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
106 ** Naming conventions
108 The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found
109 [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=.
111 #+begin_src emacs-lisp :comments none
112 ;; Naming conventions:
114 ;; ab-... public variables or non-interactive functions
115 ;; ab--... private anything (non-interactive), not safe for direct use
116 ;; ab/... an interactive function; safe for M-x or keybinding
117 ;; ab:... an evil operator, motion, or command
118 ;; ab|... a hook function
119 ;; ab*... an advising function
120 ;; ab@... a hydra command
126 :CUSTOM_ID: initial-setup
129 #+begin_src emacs-lisp :comments none
133 ** Emacs initialization
135 I'd like to do a couple of measurements of Emacs' startup time. First,
136 let's see how long Emacs takes to start up, before even loading
137 =init.el=, i.e. =user-init-file=:
139 #+begin_src emacs-lisp
140 (defvar ab--before-user-init-time (current-time)
141 "Value of `current-time' when Emacs begins loading `user-init-file'.")
142 (message "Loading Emacs...done (%.3fs)"
143 (float-time (time-subtract ab--before-user-init-time
147 Also, temporarily increase ~gc-cons-threshhold~ and
148 ~gc-cons-percentage~ during startup to reduce garbage collection
149 frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
150 startup time as well.
152 #+begin_src emacs-lisp
153 (defvar ab--gc-cons-threshold gc-cons-threshold)
154 (defvar ab--gc-cons-percentage gc-cons-percentage)
155 (defvar ab--file-name-handler-alist file-name-handler-alist)
156 (setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB
157 gc-cons-percentage 0.6
158 file-name-handler-alist nil
159 ;; sidesteps a bug when profiling with esup
160 esup-child-profile-require-level 0)
163 Of course, we'd like to set them back to their defaults once we're
166 #+begin_src emacs-lisp
170 (setq gc-cons-threshold ab--gc-cons-threshold
171 gc-cons-percentage ab--gc-cons-percentage
172 file-name-handler-alist ab--file-name-handler-alist)))
175 Increase the number of lines kept in message logs (the =*Messages*=
178 #+begin_src emacs-lisp
179 (setq message-log-max 20000)
182 Optionally, we could suppress some byte compiler warnings like below,
183 but for now I've decided to keep them enabled. See documentation for
184 ~byte-compile-warnings~ for more details.
186 #+begin_src emacs-lisp
187 ;; (setq byte-compile-warnings
188 ;; '(not free-vars unresolved noruntime lexical make-local))
191 ** Package management
195 I can do all my package management things with Borg, and don't need
196 Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
197 the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
199 #+begin_src emacs-lisp :tangle early-init.el
200 (setq package-enable-at-startup nil)
203 But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
204 right now), and even when released it'll be long before most distros
205 ship in their repos, I'll still put the old workaround with the
206 commented call to ~package-initialize~ here anyway.
208 #+begin_src emacs-lisp
209 (setq package-enable-at-startup nil)
210 ;; (package-initialize)
216 Assimilate Emacs packages as Git submodules
219 [[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
220 short, it creates a git submodule in =lib/= for each package, which
221 can then be managed with the help of Magit or other tools.
223 #+begin_src emacs-lisp
224 (setq user-init-file (or load-file-name buffer-file-name)
225 user-emacs-directory (file-name-directory user-init-file))
226 (add-to-list 'load-path
227 (expand-file-name "lib/borg" user-emacs-directory))
235 A use-package declaration for simplifying your .emacs
238 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
239 packages (in our case especially the latter) in a neatly organized way
240 and without compromising on performance.
242 #+begin_src emacs-lisp
243 (require 'use-package)
244 (if nil ; set to t when need to debug init
245 (setq use-package-verbose t
246 use-package-expand-minimally nil
247 use-package-compute-statistics t
249 (setq use-package-verbose nil
250 use-package-expand-minimally t))
256 Browse the Emacsmirror package database
259 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
260 database, low-level functions for querying the database, and a
261 =package.el=-like user interface for browsing the available packages.
263 #+begin_src emacs-lisp
268 ** No littering in =~/.emacs.d=
271 Help keeping ~/.emacs.d clean
274 By default, even for Emacs' built-in packages, the configuration files
275 and persistent data are all over the place. Use =no-littering= to help
278 #+begin_src emacs-lisp
279 (use-package no-littering
283 (add-to-list 'savehist-additional-variables 'kill-ring)
285 (setq auto-save-file-name-transforms
286 `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
289 ** Custom file (=custom.el=)
291 I'm not planning on using the custom file much, but even so, I
292 definitely don't want it mixing with =init.el=. So, here; let's give
293 it it's own file. While at it, treat themes as safe.
295 #+begin_src emacs-lisp
299 (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
300 (when (file-exists-p custom-file)
302 (setf custom-safe-themes t))
305 ** Better =$PATH= handling
307 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
310 #+begin_src emacs-lisp
311 (use-package exec-path-from-shell
314 (setq exec-path-from-shell-check-startup-files nil)
316 (exec-path-from-shell-initialize)
317 ;; while we're at it, let's fix access to our running ssh-agent
318 (exec-path-from-shell-copy-env "SSH_AGENT_PID")
319 (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
324 Start server if not already running. Alternatively, can be done by
325 issuing =emacs --daemon= in the terminal, which can be automated with
326 a systemd service or using =brew services start emacs= on macOS. I use
327 Emacs as my window manager (via EXWM), so I always start Emacs on
328 login; so starting the server from inside Emacs is good enough for me.
330 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
332 #+begin_src emacs-lisp
334 :config (or (server-running-p) (server-mode)))
339 Font stack with better unicode support, around =Ubuntu Mono= and
342 #+begin_src emacs-lisp
343 (dolist (ft (fontset-list))
347 (font-spec :name "Ubuntu Mono"))
351 (font-spec :name "DejaVu Sans Mono")
358 ;; :name "Symbola monospacified for DejaVu Sans Mono")
364 ;; (font-spec :name "DejaVu Sans Mono")
370 (font-spec :name "DejaVu Sans Mono" :size 14)
382 *** Time and battery in mode-line
384 Enable displaying time and battery in the mode-line, since I'm not
385 using the Xfce panel anymore. Also, I don't need to see the load
386 average on a regular basis, so disable that.
388 #+begin_src emacs-lisp
392 (setq display-time-default-load-average nil)
399 (display-battery-mode))
404 Might want to set the fringe to a smaller value, especially if using
405 EXWM. I'm fine with the default for now.
407 #+begin_src emacs-lisp
408 ;; (fringe-mode '(3 . 1))
412 *** Disable disabled commands
414 Emacs disables some commands by default that could persumably be
415 confusing for novice users. Let's disable that.
417 #+begin_src emacs-lisp
418 (setq disabled-command-function nil)
423 Save what I copy into clipboard from other applications into Emacs'
424 kill-ring, which would allow me to still be able to easily access it
425 in case I kill (cut or copy) something else inside Emacs before
426 yanking (pasting) what I'd originally intended to.
428 #+begin_src emacs-lisp
429 (setq save-interprogram-paste-before-kill t)
434 #+begin_src emacs-lisp
435 (setq enable-recursive-minibuffers t
436 resize-mini-windows t)
439 *** Lazy-person-friendly yes/no prompts
441 Lazy people would prefer to type fewer keystrokes, especially for yes
442 or no questions. I'm lazy.
444 #+begin_src emacs-lisp
445 (defalias 'yes-or-no-p #'y-or-n-p)
448 *** Startup screen and =*scratch*=
450 Firstly, let Emacs know that I'd like to have =*scratch*= as my
453 #+begin_src emacs-lisp
454 (setq initial-buffer-choice t)
457 Now let's customize the =*scratch*= buffer a bit. First off, I don't
458 need the default hint.
460 #+begin_src emacs-lisp
461 (setq initial-scratch-message nil)
464 Also, let's use Text mode as the major mode, in case I want to
465 customize it (=*scratch*='s default major mode, Fundamental mode,
466 can't really be customized).
468 #+begin_src emacs-lisp
469 (setq initial-major-mode 'text-mode)
472 Inhibit the buffer list when more than 2 files are loaded.
474 #+begin_src emacs-lisp
475 (setq inhibit-startup-buffer-menu t)
478 I don't really need to see the startup screen or echo area message
481 #+begin_src emacs-lisp
482 (advice-add #'display-startup-echo-area-message :override #'ignore)
483 (setq inhibit-startup-screen t
484 inhibit-startup-echo-area-message user-login-name)
487 *** More useful frame titles
489 Show either the file name or the buffer name (in case the buffer isn't
490 visiting a file). Borrowed from Emacs Prelude.
492 #+begin_src emacs-lisp
493 (setq frame-title-format
494 '("" invocation-name " - "
495 (:eval (if (buffer-file-name)
496 (abbreviate-file-name (buffer-file-name))
502 Emacs' default backup settings aren't that great. Let's use more
503 sensible options. See documentation for the ~make-backup-file~
506 #+begin_src emacs-lisp
507 (setq backup-by-copying t
513 The packages in this section are absolutely essential to my everyday
514 workflow, and they play key roles in how I do my computing. They
515 immensely enhance the Emacs experience for me; both using Emacs, and
518 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
520 #+begin_src emacs-lisp
521 (use-package auto-compile
524 (auto-compile-on-load-mode)
525 (auto-compile-on-save-mode)
526 (setq auto-compile-display-buffer nil
527 auto-compile-mode-line-counter t
528 auto-compile-source-recreate-deletes-dest t
529 auto-compile-toggle-deletes-nonlib-dest t
530 auto-compile-update-autoloads t)
531 (add-hook 'auto-compile-inhibit-compile-hook
532 'auto-compile-inhibit-compile-detached-git-head))
535 *** TODO [[https://github.com/Kungsgeten/ryo-modal][ryo-modal]]
538 Roll your own modal mode
541 *** [[https://github.com/ch11ng/exwm][EXWM]] (window manager)
543 #+begin_src emacs-lisp :tangle no
547 (require 'exwm-config)
549 ;; Set the initial workspace number.
550 (setq exwm-workspace-number 4)
552 ;; Make class name the buffer name, truncating beyond 50 characters
553 (defun exwm-rename-buffer ()
555 (exwm-workspace-rename-buffer
556 (concat exwm-class-name ":"
557 (if (<= (length exwm-title) 50) exwm-title
558 (concat (substring exwm-title 0 49) "...")))))
559 (add-hook 'exwm-update-class-hook 'exwm-rename-buffer)
560 (add-hook 'exwm-update-title-hook 'exwm-rename-buffer)
563 (exwm-input-set-key (kbd "s-R") #'exwm-reset)
564 ;; 's-\': Switch workspace
565 (exwm-input-set-key (kbd "s-\\") #'exwm-workspace-switch)
566 ;; 's-N': Switch to certain workspace
568 (exwm-input-set-key (kbd (format "s-%d" i))
571 (exwm-workspace-switch-create i))))
572 ;; 's-SPC': Launch application
573 ;; (exwm-input-set-key
576 ;; (interactive (list (read-shell-command "➜ ")))
577 ;; (start-process-shell-command command nil command)))
579 (exwm-input-set-key (kbd "M-s-SPC") #'counsel-linux-app)
581 ;; Shorten 'C-c C-q' to 'C-q'
582 (define-key exwm-mode-map [?\C-q] #'exwm-input-send-next-key)
584 ;; Line-editing shortcuts
585 (setq exwm-input-simulation-keys
590 ([?\M-f] . [C-right])
598 ([?\C-k] . [S-end delete])
600 ;; ([?\C-w] . [?\C-x])
604 ([?\C-s] . [?\C-f])))
609 (add-hook 'exwm-init-hook #'exwm-config--fix/ido-buffer-window-other-frame)
611 (require 'exwm-systemtray)
612 (exwm-systemtray-enable)
614 (require 'exwm-randr)
617 ;; (exwm-input-set-key
618 ;; (kbd "s-<return>")
621 ;; (start-process "urxvt" nil "urxvt")))
623 ;; (exwm-input-set-key
624 ;; (kbd "s-SPC") ;; rofi doesn't properly launch programs when started from emacs
627 ;; (start-process-shell-command "rofi-run" nil "rofi -show run -display-run '> ' -display-window ' 🗔 '")))
629 ;; (exwm-input-set-key
633 ;; (start-process-shell-command "rofi-win" nil "rofi -show window -display-run '> ' -display-window ' 🗔 '")))
635 ;; (exwm-input-set-key
639 ;; (start-process "rofi-pass" nil "rofi-pass")))
641 ;; (exwm-input-set-key
642 ;; (kbd "<XF86AudioMute>")
645 ;; (start-process-shell-command "pamixer" nil "pamixer --toggle-mute")))
647 ;; (exwm-input-set-key
648 ;; (kbd "<XF86AudioLowerVolume>")
651 ;; (start-process-shell-command "pamixer" nil "pamixer --allow-boost --decrease 5")))
653 ;; (exwm-input-set-key
654 ;; (kbd "<XF86AudioRaiseVolume>")
657 ;; (start-process-shell-command "pamixer" nil "pamixer --allow-boost --increase 5")))
659 ;; (exwm-input-set-key
660 ;; (kbd "<XF86AudioPlay>")
663 ;; (start-process-shell-command "mpc" nil "mpc toggle")))
665 ;; (exwm-input-set-key
666 ;; (kbd "<XF86AudioPrev>")
669 ;; (start-process-shell-command "mpc" nil "mpc prev")))
671 ;; (exwm-input-set-key
672 ;; (kbd "<XF86AudioNext>")
675 ;; (start-process-shell-command "mpc" nil "mpv next")))
677 (defun ab--exwm-pasystray ()
678 "A command used to start pasystray."
680 (if (executable-find "pasystray")
682 (message "EXWM: starting pasystray ...")
683 (start-process-shell-command "pasystray" nil "pasystray --notify=all"))
684 (message "EXWM: pasystray is not installed, abort!")))
686 (add-hook 'exwm-init-hook #'ab--exwm-pasystray)
692 (exwm-floating-toggle-floating)))
698 (exwm-layout-toggle-fullscreen)))
704 (kill-buffer (current-buffer))))
710 (exwm-manage--kill-client))))
715 :header-args+: :tangle ~/.config/sxhkd/sxhkdrc :mkdirp yes
718 #+begin_src conf :tangle no
725 rofi -show run -display-run '> ' -display-window ' 🗔 '
729 rofi -show window -display-run '> ' -display-window ' 🗔 '
735 # make sxhkd reload its configuration files:
740 XF86Audio{Raise,Lower}Volume
741 pamixer --allow-boost --{in,de}crease 5
745 pamixer --toggle-mute
748 XF86Audio{Play,Prev,Next}
749 mpc {toggle,prev,next}
751 # Toggle keyboard layout
755 # Toggle Xfce presentation mode
757 # toggle-presentation-mode
760 XF86MonBrightness{Up,Down}
767 *** [[https://orgmode.org/][Org mode]]
770 Org mode is for keeping notes, maintaining TODO lists, planning
771 projects, and authoring documents with a fast and effective plain-text
775 In short, my favourite way of life.
777 #+begin_src emacs-lisp
778 (setq org-src-tab-acts-natively t
779 org-src-preserve-indentation nil
780 org-edit-src-content-indentation 0)
783 *** [[https://magit.vc/][Magit]]
786 It's Magit! A Git porcelain inside Emacs.
789 Not just how I do git, but /the/ way to do git.
791 #+begin_src emacs-lisp
794 :bind (("s-g" . magit-status)
795 ("C-x g" . magit-status)
796 ("C-x M-g" . magit-dispatch-popup))
798 (magit-add-section-hook 'magit-status-sections-hook
799 'magit-insert-modules
800 'magit-insert-stashes
804 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
807 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
808 an overview, and more. Oh, man!
811 There's no way I could top that, so I won't attempt to.
815 #+begin_src emacs-lisp
818 (:map ivy-minibuffer-map
819 ([escape] . keyboard-escape-quit)
820 ;; ("C-j" . ivy-next-line)
821 ;; ("C-k" . ivy-previous-line)
822 ([S-up] . ivy-previous-history-element)
823 ([S-down] . ivy-next-history-element)
824 ("DEL" . ivy-backward-delete-char))
832 #+begin_src emacs-lisp
834 :bind (([remap isearch-forward] . swiper)
835 ([remap isearch-backward] . swiper)))
840 #+begin_src emacs-lisp
843 :bind (([remap execute-extended-command] . counsel-M-x)
844 ([remap find-file] . counsel-find-file)
845 ("s-r" . counsel-recentf)
846 :map minibuffer-local-map
847 ("C-r" . counsel-minibuffer-history))
850 (defalias 'locate #'counsel-locate))
853 * Borg's =layer/essentials=
855 TODO: break this giant source block down into individual org sections.
857 #+begin_src emacs-lisp
859 :config (dash-enable-font-lock))
863 (setq diff-hl-draw-borders nil)
864 (global-diff-hl-mode)
865 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
869 :config (setq dired-listing-switches "-alh"))
872 :when (version< "25" emacs-version)
873 :config (global-eldoc-mode))
877 :config (temp-buffer-resize-mode))
880 (setq isearch-allow-scroll t))
882 (use-package lisp-mode
884 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
885 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
886 (defun indent-spaces-mode ()
887 (setq indent-tabs-mode nil))
888 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
892 :config (setq Man-width 80))
895 :config (show-paren-mode))
897 (use-package prog-mode
898 :config (global-prettify-symbols-mode)
899 (defun indicate-buffer-boundaries-left ()
900 (setq indicate-buffer-boundaries 'left))
901 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
905 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
907 (use-package savehist
908 :config (savehist-mode))
910 (use-package saveplace
911 :when (version< "25" emacs-version)
912 :config (save-place-mode))
915 :config (column-number-mode))
918 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
923 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
924 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
925 (add-to-list 'tramp-default-proxies-alist
926 (list (regexp-quote (system-name)) nil nil)))
928 (use-package undo-tree
930 (global-undo-tree-mode)
931 (setq undo-tree-mode-lighter ""))
936 ** [[https://github.com/leanprover/lean-mode][Lean]]
938 #+begin_src emacs-lisp
939 (use-package lean-mode
940 :bind (:map lean-mode-map
941 ("S-SPC" . company-complete)))
944 ** [[https://github.com/haskell/haskell-mode][Haskell]]
946 #+begin_src emacs-lisp
947 (use-package haskell-mode
949 (setq haskell-indentation-layout-offset 4
950 haskell-indentation-left-offset 4
951 haskell-indentation-ifte-offset 4))
953 * Post initialization
955 :CUSTOM_ID: post-initialization
958 Display how long it took to load the init file.
960 #+begin_src emacs-lisp
961 (message "Loading %s...done (%.3fs)" user-init-file
962 (float-time (time-subtract (current-time)
963 ab--before-user-init-time)))
971 #+begin_src emacs-lisp :comments none
972 ;;; init.el ends here