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, found [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]].
110 #+begin_src emacs-lisp :comments none
111 ;; Naming conventions:
113 ;; amin-... public variables or non-interactive functions
114 ;; amin--... private anything (non-interactive), not safe for direct use
115 ;; amin/... an interactive function; safe for M-x or keybinding
116 ;; amin:... an evil operator, motion, or command
117 ;; amin|... a hook function
118 ;; amin*... an advising function
119 ;; amin@... a hydra command
125 :CUSTOM_ID: initial-setup
128 #+begin_src emacs-lisp :comments none
132 ** Emacs initialization
134 I'd like to do a couple of measurements of Emacs' startup time. First,
135 let's see how long Emacs takes to start up, before even loading
136 =init.el=, i.e. =user-init-file=:
138 #+begin_src emacs-lisp
139 (defvar amin--before-user-init-time (current-time)
140 "Value of `current-time' when Emacs begins loading `user-init-file'.")
141 (message "Loading Emacs...done (%.3fs)"
142 (float-time (time-subtract amin--before-user-init-time
146 Also, temporarily increase ~gc-cons-threshhold~ and
147 ~gc-cons-percentage~ during startup to reduce garbage collection
148 frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
149 startup time as well.
151 #+begin_src emacs-lisp
152 (defvar amin--gc-cons-threshold gc-cons-threshold)
153 (defvar amin--gc-cons-percentage gc-cons-percentage)
154 (defvar amin--file-name-handler-alist file-name-handler-alist)
155 (setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB
156 gc-cons-percentage 0.6
157 file-name-handler-alist nil
158 ;; sidesteps a bug when profiling with esup
159 esup-child-profile-require-level 0)
162 Of course, we'd like to set them back to their defaults once we're
165 #+begin_src emacs-lisp
169 (setq gc-cons-threshold amin--gc-cons-threshold
170 gc-cons-percentage amin--gc-cons-percentage
171 file-name-handler-alist amin--file-name-handler-alist)))
174 Increase the number of lines kept in message logs (the =*Messages*=
177 #+begin_src emacs-lisp
178 (setq message-log-max 20000)
181 Optionally, we could suppress some byte compiler warnings like below,
182 but for now I've decided to keep them enabled. See documentation for
183 ~byte-compile-warnings~ for more details.
185 #+begin_src emacs-lisp
186 ;; (setq byte-compile-warnings
187 ;; '(not free-vars unresolved noruntime lexical make-local))
192 #+begin_src emacs-lisp
193 (setq user-full-name "Amin Bandali"
194 user-mail-address "amin@aminb.org")
197 ** Package management
201 I can do all my package management things with Borg, and don't need
202 Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
203 the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
205 #+begin_src emacs-lisp :tangle early-init.el
206 (setq package-enable-at-startup nil)
209 But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
210 right now), and even when released it'll be long before most distros
211 ship in their repos, I'll still put the old workaround with the
212 commented call to ~package-initialize~ here anyway.
214 #+begin_src emacs-lisp
215 (setq package-enable-at-startup nil)
216 ;; (package-initialize)
222 Assimilate Emacs packages as Git submodules
225 [[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
226 short, it creates a git submodule in =lib/= for each package, which
227 can then be managed with the help of Magit or other tools.
229 #+begin_src emacs-lisp
230 (setq user-init-file (or load-file-name buffer-file-name)
231 user-emacs-directory (file-name-directory user-init-file))
232 (add-to-list 'load-path
233 (expand-file-name "lib/borg" user-emacs-directory))
237 ;; (require 'borg-nix-shell)
238 ;; (setq borg-build-shell-command 'borg-nix-shell-build-command)
240 (with-eval-after-load 'bind-key
243 ("C-c B A" . borg-activate)
244 ("C-c B a" . borg-assimilate)
245 ("C-c B b" . borg-build)
246 ("C-c B c" . borg-clone)))
252 A use-package declaration for simplifying your .emacs
255 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
256 packages (in our case especially the latter) in a neatly organized way
257 and without compromising on performance.
259 #+begin_src emacs-lisp
260 (require 'use-package)
261 (if nil ; set to t when need to debug init
262 (setq use-package-verbose t
263 use-package-expand-minimally nil
264 use-package-compute-statistics t
266 (setq use-package-verbose nil
267 use-package-expand-minimally t))
273 Browse the Emacsmirror package database
276 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
277 database, low-level functions for querying the database, and a
278 =package.el=-like user interface for browsing the available packages.
280 #+begin_src emacs-lisp
284 (("C-c B d" . epkg-describe-package)
285 ("C-c B p" . epkg-list-packages)
286 ("C-c B r" . borg-remove)
287 ("C-c B u" . epkg-update)))
290 ** No littering in =~/.emacs.d=
293 Help keeping ~/.emacs.d clean
296 By default, even for Emacs' built-in packages, the configuration files
297 and persistent data are all over the place. Use =no-littering= to help
300 #+begin_src emacs-lisp
301 (use-package no-littering
305 (add-to-list 'savehist-additional-variables 'kill-ring)
307 (setq auto-save-file-name-transforms
308 `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
311 ** Custom file (=custom.el=)
313 I'm not planning on using the custom file much, but even so, I
314 definitely don't want it mixing with =init.el=. So, here; let's give
315 it it's own file. While at it, treat themes as safe.
317 #+begin_src emacs-lisp
321 (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
322 (when (file-exists-p custom-file)
324 (setf custom-safe-themes t))
327 ** Better =$PATH= handling
329 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
332 #+begin_src emacs-lisp
333 (use-package exec-path-from-shell
336 (setq exec-path-from-shell-check-startup-files nil)
338 (exec-path-from-shell-initialize)
339 ;; while we're at it, let's fix access to our running ssh-agent
340 (exec-path-from-shell-copy-env "SSH_AGENT_PID")
341 (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
344 ** Only one custom theme at a time
346 #+begin_src emacs-lisp
347 (defadvice load-theme (before clear-previous-themes activate)
348 "Clear existing theme settings instead of layering them"
349 (mapc #'disable-theme custom-enabled-themes))
354 Start server if not already running. Alternatively, can be done by
355 issuing =emacs --daemon= in the terminal, which can be automated with
356 a systemd service or using =brew services start emacs= on macOS. I use
357 Emacs as my window manager (via EXWM), so I always start Emacs on
358 login; so starting the server from inside Emacs is good enough for me.
360 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
362 #+begin_src emacs-lisp
364 :config (or (server-running-p) (server-mode)))
369 Font stack with better unicode support, around =Ubuntu Mono= and
372 #+begin_src emacs-lisp
373 (dolist (ft (fontset-list))
377 (font-spec :name "Ubuntu Mono"))
381 (font-spec :name "DejaVu Sans Mono")
388 ;; :name "Symbola monospacified for DejaVu Sans Mono")
394 ;; (font-spec :name "DejaVu Sans Mono")
400 (font-spec :name "DejaVu Sans Mono" :size 14)
405 ** Gentler font resizing
407 #+begin_src emacs-lisp
408 (setq text-scale-mode-step 1.05)
413 #+begin_src emacs-lisp
420 #+begin_src emacs-lisp
421 (defun amin-enlist (exp)
422 "Return EXP wrapped in a list, or as-is if already a list."
423 (if (listp exp) exp (list exp)))
425 ; from https://github.com/hlissner/doom-emacs/commit/589108fdb270f24a98ba6209f6955fe41530b3ef
426 (defmacro after! (features &rest body)
427 "A smart wrapper around `with-eval-after-load'. Supresses warnings during
429 (declare (indent defun) (debug t))
430 (list (if (or (not (bound-and-true-p byte-compile-current-file))
431 (dolist (next (amin-enlist features))
433 (require next nil :no-error)
434 (load next :no-message :no-error))))
437 (cond ((symbolp features)
438 `(eval-after-load ',features '(progn ,@body)))
439 ((and (consp features)
440 (memq (car features) '(:or :any)))
442 ,@(cl-loop for next in (cdr features)
443 collect `(after! ,next ,@body))))
444 ((and (consp features)
445 (memq (car features) '(:and :all)))
446 (dolist (next (cdr features))
447 (setq body `(after! ,next ,@body)))
450 `(after! (:all ,@features) ,@body)))))
453 Convenience macro for =setq='ing multiple variables to the same value:
455 #+begin_src emacs-lisp
456 (defmacro setq-every! (value &rest vars)
457 "Set all the variables from VARS to value VALUE."
458 (declare (indent defun) (debug t))
459 `(progn ,@(mapcar (lambda (x) (list 'setq x value)) vars)))
469 *** Time and battery in mode-line
471 Enable displaying time and battery in the mode-line, since I'm not
472 using the Xfce panel anymore. Also, I don't need to see the load
473 average on a regular basis, so disable that.
475 Note: using =i3status= on sway at the moment, so disabling this.
477 #+begin_src emacs-lisp :tangle no
480 (setq display-time-default-load-average nil)
486 (display-battery-mode))
491 Might want to set the fringe to a smaller value, especially if using
492 EXWM. I'm fine with the default for now.
494 #+begin_src emacs-lisp
495 ;; (fringe-mode '(3 . 1))
499 *** Disable disabled commands
501 Emacs disables some commands by default that could persumably be
502 confusing for novice users. Let's disable that.
504 #+begin_src emacs-lisp
505 (setq disabled-command-function nil)
510 Save what I copy into clipboard from other applications into Emacs'
511 kill-ring, which would allow me to still be able to easily access it
512 in case I kill (cut or copy) something else inside Emacs before
513 yanking (pasting) what I'd originally intended to.
515 #+begin_src emacs-lisp
516 (setq save-interprogram-paste-before-kill t)
521 #+begin_src emacs-lisp
522 (setq enable-recursive-minibuffers t
523 resize-mini-windows t)
526 *** Lazy-person-friendly yes/no prompts
528 Lazy people would prefer to type fewer keystrokes, especially for yes
529 or no questions. I'm lazy.
531 #+begin_src emacs-lisp
532 (defalias 'yes-or-no-p #'y-or-n-p)
535 *** Startup screen and =*scratch*=
537 Firstly, let Emacs know that I'd like to have =*scratch*= as my
540 #+begin_src emacs-lisp
541 (setq initial-buffer-choice t)
544 Now let's customize the =*scratch*= buffer a bit. First off, I don't
545 need the default hint.
547 #+begin_src emacs-lisp
548 (setq initial-scratch-message nil)
551 Also, let's use Text mode as the major mode, in case I want to
552 customize it (=*scratch*='s default major mode, Fundamental mode,
553 can't really be customized).
555 #+begin_src emacs-lisp
556 (setq initial-major-mode 'text-mode)
559 Inhibit the buffer list when more than 2 files are loaded.
561 #+begin_src emacs-lisp
562 (setq inhibit-startup-buffer-menu t)
565 I don't really need to see the startup screen or echo area message
568 #+begin_src emacs-lisp
569 (advice-add #'display-startup-echo-area-message :override #'ignore)
570 (setq inhibit-startup-screen t
571 inhibit-startup-echo-area-message user-login-name)
574 *** More useful frame titles
576 Show either the file name or the buffer name (in case the buffer isn't
577 visiting a file). Borrowed from Emacs Prelude.
579 #+begin_src emacs-lisp
580 (setq frame-title-format
581 '("" invocation-name " - "
582 (:eval (if (buffer-file-name)
583 (abbreviate-file-name (buffer-file-name))
589 Emacs' default backup settings aren't that great. Let's use more
590 sensible options. See documentation for the ~make-backup-file~
593 #+begin_src emacs-lisp
594 (setq backup-by-copying t
596 delete-old-versions t)
601 Enable automatic reloading of changed buffers and files.
603 #+begin_src emacs-lisp
604 (global-auto-revert-mode 1)
605 (setq auto-revert-verbose nil
606 global-auto-revert-non-file-buffers t)
609 *** Always use space for indentation
611 #+begin_src emacs-lisp
614 require-final-newline t
620 Enable =winner-mode=.
622 #+begin_src emacs-lisp
626 *** Close =*compilation*= on success
628 #+begin_src emacs-lisp
629 (setq compilation-exit-message-function
630 (lambda (status code msg)
631 "Close the compilation window if successful."
632 ;; if M-x compile exits with 0
633 (when (and (eq status 'exit) (zerop code))
635 (delete-window (get-buffer-window (get-buffer "*compilation*"))))
636 ;; return the result of compilation-exit-message-function
642 #+begin_src emacs-lisp
644 ("C-c b k" . kill-this-buffer)
645 ("C-c s s" . save-buffer)
646 ("C-c b s" . save-buffer)
647 ("C-c S" . save-buffer)
648 ("C-c o" . other-window)
649 ("C-c q q" . save-buffers-kill-terminal))
654 The packages in this section are absolutely essential to my everyday
655 workflow, and they play key roles in how I do my computing. They
656 immensely enhance the Emacs experience for me; both using Emacs, and
659 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
661 #+begin_src emacs-lisp
662 (use-package auto-compile
665 (auto-compile-on-load-mode)
666 (auto-compile-on-save-mode)
667 (setq auto-compile-display-buffer nil
668 auto-compile-mode-line-counter t
669 auto-compile-source-recreate-deletes-dest t
670 auto-compile-toggle-deletes-nonlib-dest t
671 auto-compile-update-autoloads t)
672 (add-hook 'auto-compile-inhibit-compile-hook
673 'auto-compile-inhibit-compile-detached-git-head))
676 *** [[https://orgmode.org/][Org mode]]
679 Org mode is for keeping notes, maintaining TODO lists, planning
680 projects, and authoring documents with a fast and effective plain-text
684 In short, my favourite way of life.
686 #+begin_src emacs-lisp
689 (setq org-src-tab-acts-natively t
690 org-src-preserve-indentation nil
691 org-edit-src-content-indentation 0
693 :hook (org-mode . org-indent-mode))
695 (use-package org-notmuch
696 :after (:any org notmuch))
698 (use-package orgalist)
701 **** asynchronous tangle
703 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
704 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
707 #+begin_src emacs-lisp
709 (defvar amin-show-async-tangle-results nil
710 "Keep *emacs* async buffers around for later inspection.")
712 (defvar amin-show-async-tangle-time nil
713 "Show the time spent tangling the file.")
715 (defvar amin-async-tangle-post-compile "make ti"
716 "If non-nil, pass to `compile' after successful tangle.")
718 (defun amin/async-babel-tangle ()
719 "Tangle org file asynchronously."
721 (let* ((file-tangle-start-time (current-time))
722 (file (buffer-file-name))
723 (file-nodir (file-name-nondirectory file))
724 (async-quiet-switch "-q"))
728 (org-babel-tangle-file ,file))
729 (unless amin-show-async-tangle-results
733 (message "Tangled %s%s"
735 (if amin-show-async-tangle-time
737 (float-time (time-subtract (current-time)
738 ',file-tangle-start-time)))
740 (when amin-async-tangle-post-compile
741 (compile amin-async-tangle-post-compile)))
742 (message "Tangling %s failed" ,file-nodir))))))))
745 'safe-local-variable-values
746 '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
749 *** [[https://magit.vc/][Magit]]
752 It's Magit! A Git porcelain inside Emacs.
755 Not just how I do git, but /the/ way to do git.
757 #+begin_src emacs-lisp
761 (("s-g" . magit-dispatch-popup)
762 ("C-x g" . magit-status)
763 :prefix-map amin--magit-prefix-map
765 ("SPC" . magit-status)
767 ("S" . magit-status-prefix)
773 ("p" . magit-dispatch-popup)
774 ("c c" . magit-commit)
775 ("c a" . magit-commit-amend)
776 ("b b" . magit-checkout)
777 ("b c" . magit-branch))
779 (magit-add-section-hook 'magit-status-sections-hook
780 'magit-insert-modules
781 'magit-insert-stashes
785 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
788 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
789 an overview, and more. Oh, man!
792 There's no way I could top that, so I won't attempt to.
796 #+begin_src emacs-lisp
800 (("C-c b b" . ivy-switch-buffer)
801 :map ivy-minibuffer-map
802 ([escape] . keyboard-escape-quit)
803 ([S-up] . ivy-previous-history-element)
804 ([S-down] . ivy-next-history-element)
805 ("DEL" . ivy-backward-delete-char))
813 #+begin_src emacs-lisp
815 :bind (([remap isearch-forward] . swiper)
816 ([remap isearch-backward] . swiper)))
821 #+begin_src emacs-lisp
824 :bind (([remap execute-extended-command] . counsel-M-x)
825 ([remap find-file] . counsel-find-file)
826 ("s-r" . counsel-recentf)
827 ("C-c x" . counsel-M-x)
828 ("C-c f ." . counsel-find-file)
829 ("C-c f r" . counsel-recentf)
830 :map minibuffer-local-map
831 ("C-r" . counsel-minibuffer-history))
834 (defalias 'locate #'counsel-locate))
839 #+begin_src emacs-lisp
843 (eval-when-compile (defvar eshell-prompt-regexp))
844 (defun amin/eshell-quit-or-delete-char (arg)
846 (if (and (eolp) (looking-back eshell-prompt-regexp nil))
847 (eshell-life-is-too-much)
850 (defun amin/eshell-clear ()
852 (let ((inhibit-read-only t))
856 (defun amin|eshell-setup ()
857 (bind-keys :map eshell-mode-map
858 ("C-d" . amin/eshell-quit-or-delete-char)
859 ("C-l" . amin/eshell-clear)))
861 :hook (eshell-mode . amin|eshell-setup))
866 #+begin_src emacs-lisp
869 (("C-x C-b" . ibuffer-other-window)
870 ("C-c b B" . ibuffer-other-window)
871 :map ibuffer-mode-map
872 ("P" . ibuffer-backward-filter-group)
873 ("N" . ibuffer-forward-filter-group)
874 ("M-p" . ibuffer-do-print)
875 ("M-n" . ibuffer-do-shell-command-pipe-replace))
877 ;; Use human readable Size column instead of original one
878 (define-ibuffer-column size-h
879 (:name "Size" :inline t)
881 ((> (buffer-size) 1000000) (format "%7.1fM" (/ (buffer-size) 1000000.0)))
882 ((> (buffer-size) 100000) (format "%7.0fk" (/ (buffer-size) 1000.0)))
883 ((> (buffer-size) 1000) (format "%7.1fk" (/ (buffer-size) 1000.0)))
884 (t (format "%8d" (buffer-size)))))
886 (ibuffer-saved-filter-groups
888 ("dired" (mode . dired-mode))
889 ("org" (name . "^.*org$"))
899 (mode . shell-mode)))
900 ("notmuch" (name . "\*notmuch\*"))
905 (mode . emacs-lisp-mode)))
908 (name . "^\\*scratch\\*$")
909 (name . "^\\*Messages\\*$"))))))
911 '((mark modified read-only locked " "
912 (name 18 18 :left :elide)
916 (mode 16 16 :left :elide)
917 " " filename-and-process)
921 :hook (ibuffer . (lambda () (ibuffer-switch-to-saved-filter-groups "default"))))
924 * Borg's =layer/essentials=
926 TODO: break this giant source block down into individual org sections.
928 #+begin_src emacs-lisp
930 :config (dash-enable-font-lock))
934 (setq diff-hl-draw-borders nil)
935 (global-diff-hl-mode)
936 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
940 :config (setq dired-listing-switches "-alh"))
943 :when (version< "25" emacs-version)
944 :config (global-eldoc-mode))
948 :config (temp-buffer-resize-mode))
951 (setq isearch-allow-scroll t))
953 (use-package lisp-mode
955 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
956 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
957 (defun indent-spaces-mode ()
958 (setq indent-tabs-mode nil))
959 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
963 :config (setq Man-width 80))
966 :config (show-paren-mode))
968 (use-package prog-mode
969 :config (global-prettify-symbols-mode)
970 (defun indicate-buffer-boundaries-left ()
971 (setq indicate-buffer-boundaries 'left))
972 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
977 (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:")
978 (setq recentf-max-saved-items 40))
980 (use-package savehist
981 :config (savehist-mode))
983 (use-package saveplace
984 :when (version< "25" emacs-version)
985 :config (save-place-mode))
988 :config (column-number-mode))
991 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
996 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
997 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
998 (add-to-list 'tramp-default-proxies-alist
999 (list (regexp-quote (system-name)) nil nil)))
1001 (use-package undo-tree
1002 :bind (("C-?" . undo-tree-undo)
1003 ("M-_" . undo-tree-redo))
1005 (global-undo-tree-mode)
1006 (setq undo-tree-mode-lighter ""
1007 undo-tree-auto-save-history t))
1014 #+begin_src emacs-lisp
1015 (use-package company
1018 (:map company-active-map
1019 ([tab] . company-complete-common-or-cycle))
1021 (company-idle-delay 0.3)
1022 (company-minimum-prefix-length 1)
1023 (company-selection-wrap-around t)
1024 (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
1025 (company-dabbrev-downcase nil)
1026 (company-dabbrev-ignore-case nil)
1028 (global-company-mode t))
1031 * Syntax and spell checking
1032 #+begin_src emacs-lisp
1033 (use-package flycheck
1034 :hook (prog-mode . flycheck-mode)
1036 ;; Use the load-path from running Emacs when checking elisp files
1037 (setq flycheck-emacs-lisp-load-path 'inherit)
1039 ;; Only flycheck when I actually save the buffer
1040 (setq flycheck-check-syntax-automatically '(mode-enabled save)))
1044 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
1046 #+begin_src emacs-lisp
1047 (use-package alloy-mode
1048 :config (setq alloy-basic-offset 2))
1051 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
1053 #+begin_src emacs-lisp
1054 (use-package proof-site ; Proof General
1055 :load-path "lib/proof-site/generic/")
1058 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
1060 #+begin_src emacs-lisp
1061 (eval-when-compile (defvar lean-mode-map))
1062 (use-package lean-mode
1063 :bind (:map lean-mode-map
1064 ("S-SPC" . company-complete)))
1069 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
1071 #+begin_src emacs-lisp
1072 (use-package haskell-mode
1074 (setq haskell-indentation-layout-offset 4
1075 haskell-indentation-left-offset 4
1076 flycheck-checker 'haskell-hlint
1077 flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
1080 *** [[https://github.com/jyp/dante][dante]]
1082 #+begin_src emacs-lisp
1085 :commands dante-mode
1086 :hook (haskell-mode . dante-mode))
1089 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1091 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1092 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1094 #+begin_src emacs-lisp
1095 (use-package hlint-refactor
1096 :bind (:map hlint-refactor-mode-map
1097 ("C-c l b" . hlint-refactor-refactor-buffer)
1098 ("C-c l r" . hlint-refactor-refactor-at-point))
1099 :hook (haskell-mode . hlint-refactor-mode))
1102 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1104 #+begin_src emacs-lisp
1105 (use-package flycheck-haskell)
1108 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1110 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1113 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1116 #+begin_src emacs-lisp :tangle no
1117 ;;; hs-lint.el --- minor mode for HLint code checking
1119 ;; Copyright 2009 (C) Alex Ott
1121 ;; Author: Alex Ott <alexott@gmail.com>
1122 ;; Keywords: haskell, lint, HLint
1124 ;; Status: distributed under terms of GPL2 or above
1126 ;; Typical message from HLint looks like:
1128 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1130 ;; count1 p l = length (filter p l)
1132 ;; count1 p = length . filter p
1137 (defgroup hs-lint nil
1138 "Run HLint as inferior of Emacs, parse error messages."
1142 (defcustom hs-lint-command "hlint"
1143 "The default hs-lint command for \\[hlint]."
1147 (defcustom hs-lint-save-files t
1148 "Save modified files when run HLint or no (ask user)"
1152 (defcustom hs-lint-replace-with-suggestions nil
1153 "Replace user's code with suggested replacements"
1157 (defcustom hs-lint-replace-without-ask nil
1158 "Replace user's code with suggested replacements automatically"
1162 (defun hs-lint-process-setup ()
1163 "Setup compilation variables and buffer for `hlint'."
1164 (run-hooks 'hs-lint-setup-hook))
1166 ;; regex for replace suggestions
1168 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1174 (defvar hs-lint-regex
1175 "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1176 "Regex for HLint messages")
1178 (defun make-short-string (str maxlen)
1179 (if (< (length str) maxlen)
1181 (concat (substring str 0 (- maxlen 3)) "...")))
1183 (defun hs-lint-replace-suggestions ()
1184 "Perform actual replacement of suggestions"
1185 (goto-char (point-min))
1186 (while (re-search-forward hs-lint-regex nil t)
1187 (let* ((fname (match-string 1))
1188 (fline (string-to-number (match-string 2)))
1189 (old-code (match-string 4))
1190 (new-code (match-string 5))
1191 (msg (concat "Replace '" (make-short-string old-code 30)
1192 "' with '" (make-short-string new-code 30) "'"))
1198 (switch-to-buffer (get-file-buffer fname))
1199 (goto-char (point-min))
1200 (forward-line (1- fline))
1202 (setf bline (point))
1203 (when (or hs-lint-replace-without-ask
1206 (setf eline (point))
1208 (setf old-code (regexp-quote old-code))
1209 (while (string-match "\\\\ " old-code spos)
1210 (setf new-old-code (concat new-old-code
1211 (substring old-code spos (match-beginning 0))
1213 (setf spos (match-end 0)))
1214 (setf new-old-code (concat new-old-code (substring old-code spos)))
1215 (remove-text-properties bline eline '(composition nil))
1216 (when (re-search-forward new-old-code eline t)
1217 (replace-match new-code nil t)))))))
1219 (defun hs-lint-finish-hook (buf msg)
1220 "Function, that is executed at the end of HLint execution"
1221 (if hs-lint-replace-with-suggestions
1222 (hs-lint-replace-suggestions)
1225 (define-compilation-mode hs-lint-mode "HLint"
1226 "Mode for check Haskell source code."
1227 (set (make-local-variable 'compilation-process-setup-function)
1228 'hs-lint-process-setup)
1229 (set (make-local-variable 'compilation-disable-input) t)
1230 (set (make-local-variable 'compilation-scroll-output) nil)
1231 (set (make-local-variable 'compilation-finish-functions)
1232 (list 'hs-lint-finish-hook))
1236 "Run HLint for current buffer with haskell source"
1238 (save-some-buffers hs-lint-save-files)
1239 (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1243 ;;; hs-lint.el ends here
1246 #+begin_src emacs-lisp :tangle no
1247 (use-package hs-lint
1249 :bind (:map haskell-mode-map
1250 ("C-c l l" . hs-lint)))
1257 #+begin_src emacs-lisp
1258 (use-package sgml-mode
1260 (setq sgml-basic-offset 2))
1265 #+begin_src emacs-lisp
1266 (use-package css-mode
1268 (setq css-indent-offset 2))
1273 #+begin_src emacs-lisp
1274 (use-package web-mode
1278 web-mode-code-indent-offset
1279 web-mode-css-indent-offset
1280 web-mode-markup-indent-offset))
1285 #+begin_src emacs-lisp
1286 (use-package emmet-mode
1287 :bind* (("C-)" . emmet-next-edit-point)
1288 ("C-(" . emmet-prev-edit-point))
1290 (unbind-key "C-j" emmet-mode-keymap)
1291 (setq emmet-move-cursor-between-quotes t)
1292 :hook (web-mode css-mode html-mode sgml-mode))
1297 #+begin_src emacs-lisp
1298 (use-package nix-mode
1302 * Emacs Enhancements
1304 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1307 Emacs package that displays available keybindings in popup
1310 #+begin_src emacs-lisp
1311 (use-package which-key
1313 :config (which-key-mode))
1316 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1318 #+begin_src emacs-lisp
1319 (use-package doom-modeline
1321 :config (setq doom-modeline-height 32)
1322 :hook (after-init . doom-modeline-init))
1325 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1327 #+begin_src emacs-lisp :tangle no
1328 (use-package tao-theme
1330 :config (load-theme 'tao-yang t))
1333 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1335 #+begin_src emacs-lisp
1336 (load-theme 'eink t)
1339 ** [[https://github.com/bbatsov/crux][crux]]
1341 #+begin_src emacs-lisp
1343 :bind (("C-c d" . crux-duplicate-current-line-or-region)
1344 ("C-c M-d" . crux-duplicate-and-comment-current-line-or-region)
1345 ("C-c b K" . crux-kill-other-buffers)
1346 ("C-c f c" . crux-copy-file-preserve-attributes)
1347 ("C-c f D" . crux-delete-file-and-buffer)
1348 ("C-c f R" . crux-rename-file-and-buffer)
1349 ("C-S-j" . crux-top-join-line)
1350 ("C-c j" . crux-top-join-line)))
1353 ** [[https://github.com/alezost/mwim.el][mwim]]
1355 #+begin_src emacs-lisp
1357 :bind (("C-a" . mwim-beginning-of-code-or-line)
1358 ("C-e" . mwim-end-of-code-or-line)
1359 ("<home>" . mwim-beginning-of-line-or-code)
1360 ("<end>" . mwim-end-of-line-or-code)))
1365 #+begin_src emacs-lisp
1366 (use-package projectile
1368 :bind-keymap ("C-c p" . projectile-command-map)
1372 (defun my-projectile-invalidate-cache (&rest _args)
1373 ;; ignore the args to `magit-checkout'
1374 (projectile-invalidate-cache nil))
1376 (eval-after-load 'magit-branch
1378 (advice-add 'magit-checkout
1379 :after #'my-projectile-invalidate-cache)
1380 (advice-add 'magit-branch-and-checkout
1381 :after #'my-projectile-invalidate-cache))))
1384 ** [[https://github.com/Wilfred/helpful][helpful]]
1386 #+begin_src emacs-lisp
1387 (use-package helpful
1389 (("C-h f" . helpful-callable)
1390 ("C-h v" . helpful-variable)
1391 ("C-h k" . helpful-key)
1392 ("C-c C-d" . helpful-at-point)
1393 ("C-h F" . helpful-function)
1394 ("C-h C" . helpful-command)))
1397 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1399 #+begin_src emacs-lisp
1400 (use-package shell-pop
1402 (shell-pop-universal-key "C-c e")
1403 (shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1406 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1408 Make =*scratch*= and =*Messages*= unkillable.
1410 #+begin_src emacs-lisp
1411 (use-package unkillable-scratch
1413 (unkillable-scratch 1)
1415 (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1418 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1422 | make pretty boxed quotes like this
1426 #+begin_src emacs-lisp
1427 (use-package boxquote
1429 (:prefix-map amin--boxquote-prefix-map
1431 ("b" . boxquote-buffer)
1432 ("B" . boxquote-insert-buffer)
1433 ("d" . boxquote-defun)
1434 ("F" . boxquote-insert-file)
1435 ("hf" . boxquote-describe-function)
1436 ("hk" . boxquote-describe-key)
1437 ("hv" . boxquote-describe-variable)
1438 ("hw" . boxquote-where-is)
1439 ("k" . boxquote-kill)
1440 ("p" . boxquote-paragraph)
1441 ("q" . boxquote-boxquote)
1442 ("r" . boxquote-region)
1443 ("s" . boxquote-shell-command)
1444 ("t" . boxquote-text)
1445 ("T" . boxquote-title)
1446 ("u" . boxquote-unbox)
1447 ("U" . boxquote-unbox-region)
1448 ("y" . boxquote-yank)
1449 ("M-q" . boxquote-fill-paragraph)
1450 ("M-w" . boxquote-kill-ring-save)))
1453 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1455 ** [[https://github.com/DarthFennec/highlight-indent-guides][highlight-indent-guides]]
1457 #+begin_src emacs-lisp
1458 (use-package highlight-indent-guides
1460 :hook ((prog-mode . highlight-indent-guides-mode)
1461 (org-mode . highlight-indent-guides-mode))
1463 (setq highlight-indent-guides-character ?\|)
1464 (setq highlight-indent-guides-auto-enabled nil)
1465 (setq highlight-indent-guides-method 'character)
1466 (setq highlight-indent-guides-responsive 'top)
1467 (set-face-foreground 'highlight-indent-guides-character-face "gainsboro")
1468 (set-face-foreground 'highlight-indent-guides-top-character-face "grey40")) ; grey13 is nice too
1473 #+begin_src emacs-lisp
1474 (defvar amin-maildir (expand-file-name "~/mail/"))
1476 (add-to-list 'recentf-exclude amin-maildir))
1481 #+begin_src emacs-lisp
1482 (use-package sendmail
1484 (setq sendmail-program "/usr/bin/msmtp"
1485 ;; message-sendmail-extra-arguments '("-v" "-d")
1486 mail-specify-envelope-from t
1487 mail-envelope-from 'header))
1492 #+begin_src emacs-lisp
1493 (use-package message
1495 (setq message-kill-buffer-on-exit t
1496 message-send-mail-function 'message-send-mail-with-sendmail
1497 message-sendmail-envelope-from 'header
1498 ;; message-directory "drafts"
1499 message-user-fqdn "aminb.org")
1500 (add-hook 'message-mode-hook
1501 (lambda () (setq fill-column 65
1502 message-fill-column 65)))
1503 (add-hook 'message-mode-hook
1505 ;; (add-hook 'message-setup-hook
1506 ;; #'mml-secure-message-sign-pgpmime)
1510 (setq mml-secure-openpgp-encrypt-to-self t
1511 mml-secure-openpgp-sign-with-sender t))
1514 ** [[https://notmuchmail.org][notmuch]]
1516 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1518 #+begin_src emacs-lisp
1519 (defun amin/notmuch ()
1520 "Delete other windows, then launch `notmuch'."
1522 (delete-other-windows)
1525 (use-package notmuch
1527 :bind ("C-c n" . amin/notmuch)
1528 :custom (notmuch-always-prompt-for-sender t)
1530 (setq notmuch-hello-sections
1531 '(notmuch-hello-insert-header
1532 notmuch-hello-insert-saved-searches
1533 ;; notmuch-hello-insert-search
1534 notmuch-hello-insert-alltags)
1535 notmuch-search-oldest-first nil
1536 notmuch-show-all-tags-list t
1537 notmuch-message-headers ; see bug follow-up above
1538 '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1539 notmuch-hello-thousands-separator ","
1541 '(("amin@aminb.org" . "amin/Sent")
1542 ("amin@gnu.org" . "gnu/Sent")
1543 ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1544 ("mab@gnu.org" . "gnu/Sent")
1545 ("aminb@gnu.org" . "gnu/Sent")
1547 notmuch-search-result-format
1548 '(("date" . "%12s ")
1550 ("authors" . "%-40s ")
1553 notmuch-saved-searches
1554 '((:name "inbox" :query "tag:inbox" :key "i")
1555 (:name "unread" :query "tag:unread" :key "u")
1556 (:name "latest" :query "tag:latest" :key "l")
1557 (:name "encrypted" :query "tag:encrypted" :key "e")
1558 (:name "flagged" :query "tag:flagged" :key "f")
1559 (:name "sent" :query "tag:sent" :key "s")
1560 (:name "drafts" :query "tag:draft" :key "d")
1561 (:name "all mail" :query "*" :key "a")))
1562 ;; (add-hook 'visual-fill-column-mode-hook
1564 ;; (when (string= major-mode 'notmuch-message-mode)
1565 ;; (setq visual-fill-column-width 70))))
1566 ;; (set! :evil-state 'notmuch-message-mode 'insert)
1567 ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1568 ;; :override #'kill-this-buffer)
1570 (:map notmuch-hello-mode-map
1572 "Search for `unread'-tagged messages"
1574 (notmuch-hello-search "tag:unread")))
1576 "Search for `inbox'-tagged messages"
1578 (notmuch-hello-search "tag:inbox")))
1580 "Search for `latest'-tagged messages"
1582 (notmuch-hello-search "tag:latest")))
1584 "Search for `encrypted'-tagged messages"
1586 (notmuch-hello-search "tag:encrypted"))))
1587 (:map notmuch-search-mode-map
1591 (notmuch-search-tag '("-unread"))
1592 ;; (notmuch-search-archive-thread)
1593 (notmuch-search-next-thread)))
1595 "Mark message unread"
1597 (notmuch-search-tag '("+unread"))
1598 (notmuch-search-next-thread)))
1600 "Mark message deleted"
1602 (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1603 (notmuch-search-next-thread)))
1605 "Mark message as spam"
1607 (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1608 (notmuch-search-next-thread))))
1609 (:map notmuch-tree-mode-map
1613 (notmuch-tree-tag '("-unread"))
1614 ;; (notmuch-tree-archive-thread)
1615 (notmuch-tree-next-message)))
1617 "Mark message unread"
1619 (notmuch-tree-tag '("+unread"))
1620 (notmuch-tree-next-message)))
1622 "Mark message deleted"
1624 (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
1625 (notmuch-tree-next-message)))
1627 "Mark message as spam"
1629 (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1630 (notmuch-tree-next-message)))))
1632 (use-package counsel-notmuch
1633 :bind ("C-c s m" . counsel-notmuch))
1635 (after! notmuch-crypto
1636 (setq notmuch-crypto-process-mime t))
1641 #+begin_src emacs-lisp :tangle no
1642 (use-package supercite
1643 :commands sc-cite-original
1645 (add-hook 'mail-citation-hook 'sc-cite-original)
1647 (defun sc-remove-existing-signature ()
1649 (goto-char (region-beginning))
1650 (when (re-search-forward message-signature-separator (region-end) t)
1651 (delete-region (match-beginning 0) (region-end)))))
1653 (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1655 (defun sc-remove-if-not-mailing-list ()
1656 (unless (assoc "list-id" sc-mail-info)
1657 (setq attribution sc-default-attribution
1658 citation (concat sc-citation-delimiter
1659 sc-citation-separator))))
1661 (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1664 (defun sc-fill-if-different (&optional prefix)
1665 "Fill the region bounded by `sc-fill-begin' and point.
1666 Only fill if optional PREFIX is different than
1667 `sc-fill-line-prefix'. If `sc-auto-fill-region-p' is nil, do not
1668 fill region. If PREFIX is not supplied, initialize fill
1669 variables. This is useful for a regi `begin' frame-entry."
1671 (setq sc-fill-line-prefix ""
1672 sc-fill-begin (line-beginning-position))
1673 (if (and sc-auto-fill-region-p
1674 (not (string= prefix sc-fill-line-prefix)))
1675 (let ((fill-prefix sc-fill-line-prefix))
1676 (unless (or (string= fill-prefix "")
1678 (goto-char sc-fill-begin)
1679 (or (looking-at ">+ +")
1681 (buffer-substring (point)
1682 (line-end-position)))
1684 (fill-region sc-fill-begin (line-beginning-position)))
1685 (setq sc-fill-line-prefix prefix
1686 sc-fill-begin (line-beginning-position)))))
1691 ** [[https://ox-hugo.scripter.co][ox-hugo]]
1693 #+begin_src emacs-lisp
1694 (use-package ox-hugo
1697 (use-package ox-hugo-auto-export
1698 :load-path "lib/ox-hugo")
1701 * Post initialization
1703 :CUSTOM_ID: post-initialization
1706 Display how long it took to load the init file.
1708 #+begin_src emacs-lisp
1709 (message "Loading %s...done (%.3fs)" user-init-file
1710 (float-time (time-subtract (current-time)
1711 amin--before-user-init-time)))
1719 #+begin_src emacs-lisp :comments none
1720 ;;; init.el ends here
1723 * COMMENT Local Variables :ARCHIVE:
1725 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)