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)
407 #+begin_src emacs-lisp
414 #+begin_src emacs-lisp
415 (defun amin-enlist (exp)
416 "Return EXP wrapped in a list, or as-is if already a list."
417 (if (listp exp) exp (list exp)))
419 ; from https://github.com/hlissner/doom-emacs/commit/589108fdb270f24a98ba6209f6955fe41530b3ef
420 (defmacro after! (features &rest body)
421 "A smart wrapper around `with-eval-after-load'. Supresses warnings during
423 (declare (indent defun) (debug t))
424 (list (if (or (not (bound-and-true-p byte-compile-current-file))
425 (dolist (next (amin-enlist features))
427 (require next nil :no-error)
428 (load next :no-message :no-error))))
431 (cond ((symbolp features)
432 `(eval-after-load ',features '(progn ,@body)))
433 ((and (consp features)
434 (memq (car features) '(:or :any)))
436 ,@(cl-loop for next in (cdr features)
437 collect `(after! ,next ,@body))))
438 ((and (consp features)
439 (memq (car features) '(:and :all)))
440 (dolist (next (cdr features))
441 (setq body `(after! ,next ,@body)))
444 `(after! (:all ,@features) ,@body)))))
454 *** Time and battery in mode-line
456 Enable displaying time and battery in the mode-line, since I'm not
457 using the Xfce panel anymore. Also, I don't need to see the load
458 average on a regular basis, so disable that.
460 Note: using =i3status= on sway at the moment, so disabling this.
462 #+begin_src emacs-lisp :tangle no
465 (setq display-time-default-load-average nil)
471 (display-battery-mode))
476 Might want to set the fringe to a smaller value, especially if using
477 EXWM. I'm fine with the default for now.
479 #+begin_src emacs-lisp
480 ;; (fringe-mode '(3 . 1))
484 *** Disable disabled commands
486 Emacs disables some commands by default that could persumably be
487 confusing for novice users. Let's disable that.
489 #+begin_src emacs-lisp
490 (setq disabled-command-function nil)
495 Save what I copy into clipboard from other applications into Emacs'
496 kill-ring, which would allow me to still be able to easily access it
497 in case I kill (cut or copy) something else inside Emacs before
498 yanking (pasting) what I'd originally intended to.
500 #+begin_src emacs-lisp
501 (setq save-interprogram-paste-before-kill t)
506 #+begin_src emacs-lisp
507 (setq enable-recursive-minibuffers t
508 resize-mini-windows t)
511 *** Lazy-person-friendly yes/no prompts
513 Lazy people would prefer to type fewer keystrokes, especially for yes
514 or no questions. I'm lazy.
516 #+begin_src emacs-lisp
517 (defalias 'yes-or-no-p #'y-or-n-p)
520 *** Startup screen and =*scratch*=
522 Firstly, let Emacs know that I'd like to have =*scratch*= as my
525 #+begin_src emacs-lisp
526 (setq initial-buffer-choice t)
529 Now let's customize the =*scratch*= buffer a bit. First off, I don't
530 need the default hint.
532 #+begin_src emacs-lisp
533 (setq initial-scratch-message nil)
536 Also, let's use Text mode as the major mode, in case I want to
537 customize it (=*scratch*='s default major mode, Fundamental mode,
538 can't really be customized).
540 #+begin_src emacs-lisp
541 (setq initial-major-mode 'text-mode)
544 Inhibit the buffer list when more than 2 files are loaded.
546 #+begin_src emacs-lisp
547 (setq inhibit-startup-buffer-menu t)
550 I don't really need to see the startup screen or echo area message
553 #+begin_src emacs-lisp
554 (advice-add #'display-startup-echo-area-message :override #'ignore)
555 (setq inhibit-startup-screen t
556 inhibit-startup-echo-area-message user-login-name)
559 *** More useful frame titles
561 Show either the file name or the buffer name (in case the buffer isn't
562 visiting a file). Borrowed from Emacs Prelude.
564 #+begin_src emacs-lisp
565 (setq frame-title-format
566 '("" invocation-name " - "
567 (:eval (if (buffer-file-name)
568 (abbreviate-file-name (buffer-file-name))
574 Emacs' default backup settings aren't that great. Let's use more
575 sensible options. See documentation for the ~make-backup-file~
578 #+begin_src emacs-lisp
579 (setq backup-by-copying t
581 delete-old-versions t)
586 Enable automatic reloading of changed buffers and files.
588 #+begin_src emacs-lisp
589 (global-auto-revert-mode 1)
590 (setq auto-revert-verbose nil
591 global-auto-revert-non-file-buffers t)
594 *** Always use space for indentation
596 #+begin_src emacs-lisp
599 require-final-newline t
605 Enable =winner-mode=.
607 #+begin_src emacs-lisp
611 *** Close =*compilation*= on success
613 #+begin_src emacs-lisp
614 (setq compilation-exit-message-function
615 (lambda (status code msg)
616 "Close the compilation window if successful."
617 ;; if M-x compile exits with 0
618 (when (and (eq status 'exit) (zerop code))
620 (delete-window (get-buffer-window (get-buffer "*compilation*"))))
621 ;; return the result of compilation-exit-message-function
627 #+begin_src emacs-lisp
629 ("C-c b B" . ibuffer-list-buffers)
630 ("C-c b k" . kill-this-buffer)
631 ("C-c b s" . save-buffer)
632 ("C-c S" . save-buffer)
633 ("C-c o" . other-window)
634 ("C-c q q" . save-buffers-kill-terminal))
639 The packages in this section are absolutely essential to my everyday
640 workflow, and they play key roles in how I do my computing. They
641 immensely enhance the Emacs experience for me; both using Emacs, and
644 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
646 #+begin_src emacs-lisp
647 (use-package auto-compile
650 (auto-compile-on-load-mode)
651 (auto-compile-on-save-mode)
652 (setq auto-compile-display-buffer nil
653 auto-compile-mode-line-counter t
654 auto-compile-source-recreate-deletes-dest t
655 auto-compile-toggle-deletes-nonlib-dest t
656 auto-compile-update-autoloads t)
657 (add-hook 'auto-compile-inhibit-compile-hook
658 'auto-compile-inhibit-compile-detached-git-head))
661 *** [[https://orgmode.org/][Org mode]]
664 Org mode is for keeping notes, maintaining TODO lists, planning
665 projects, and authoring documents with a fast and effective plain-text
669 In short, my favourite way of life.
671 #+begin_src emacs-lisp
674 (setq org-src-tab-acts-natively t
675 org-src-preserve-indentation nil
676 org-edit-src-content-indentation 0)
677 :hook (org-mode . org-indent-mode))
679 (use-package org-notmuch
680 :after (:any org notmuch))
683 **** asynchronous tangle
685 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
686 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
689 #+begin_src emacs-lisp
691 (defvar amin-show-async-tangle-results nil
692 "Keep *emacs* async buffers around for later inspection.")
694 (defvar amin-show-async-tangle-time nil
695 "Show the time spent tangling the file.")
697 (defvar amin-async-tangle-post-compile "make ti"
698 "If non-nil, pass to `compile' after successful tangle.")
700 (defun amin/async-babel-tangle ()
701 "Tangle org file asynchronously."
703 (let* ((file-tangle-start-time (current-time))
704 (file (buffer-file-name))
705 (file-nodir (file-name-nondirectory file))
706 (async-quiet-switch "-q"))
710 (org-babel-tangle-file ,file))
711 (unless amin-show-async-tangle-results
715 (message "Tangled %s%s"
717 (if amin-show-async-tangle-time
719 (float-time (time-subtract (current-time)
720 ',file-tangle-start-time)))
722 (when amin-async-tangle-post-compile
723 (compile amin-async-tangle-post-compile)))
724 (message "Tangling %s failed" ,file-nodir))))))))
727 'safe-local-variable-values
728 '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
731 *** [[https://magit.vc/][Magit]]
734 It's Magit! A Git porcelain inside Emacs.
737 Not just how I do git, but /the/ way to do git.
739 #+begin_src emacs-lisp
743 (("s-g" . magit-dispatch-popup)
744 ("C-x g" . magit-status)
745 :prefix-map amin--magit-prefix-map
747 ("SPC" . magit-status)
749 ("S" . magit-status-prefix)
755 ("p" . magit-dispatch-popup)
756 ("c c" . magit-commit)
757 ("c a" . magit-commit-amend)
758 ("b b" . magit-checkout)
759 ("b c" . magit-branch))
761 (magit-add-section-hook 'magit-status-sections-hook
762 'magit-insert-modules
763 'magit-insert-stashes
767 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
770 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
771 an overview, and more. Oh, man!
774 There's no way I could top that, so I won't attempt to.
778 #+begin_src emacs-lisp
782 (("C-c b b" . ivy-switch-buffer)
783 :map ivy-minibuffer-map
784 ([escape] . keyboard-escape-quit)
785 ([S-up] . ivy-previous-history-element)
786 ([S-down] . ivy-next-history-element)
787 ("DEL" . ivy-backward-delete-char))
795 #+begin_src emacs-lisp
797 :bind (([remap isearch-forward] . swiper)
798 ([remap isearch-backward] . swiper)))
803 #+begin_src emacs-lisp
806 :bind (([remap execute-extended-command] . counsel-M-x)
807 ([remap find-file] . counsel-find-file)
808 ("s-r" . counsel-recentf)
809 ("C-c x" . counsel-M-x)
810 ("C-c f ." . counsel-find-file)
811 ("C-c f r" . counsel-recentf)
812 :map minibuffer-local-map
813 ("C-r" . counsel-minibuffer-history))
816 (defalias 'locate #'counsel-locate))
821 #+begin_src emacs-lisp
825 (eval-when-compile (defvar eshell-prompt-regexp))
826 (defun amin/eshell-quit-or-delete-char (arg)
828 (if (and (eolp) (looking-back eshell-prompt-regexp nil))
829 (eshell-life-is-too-much)
832 (defun amin/eshell-clear ()
834 (let ((inhibit-read-only t))
838 (defun amin|eshell-setup ()
839 (bind-keys :map eshell-mode-map
840 ("C-d" . amin/eshell-quit-or-delete-char)
841 ("C-l" . amin/eshell-clear)))
843 :hook (eshell-mode . amin|eshell-setup))
846 * Borg's =layer/essentials=
848 TODO: break this giant source block down into individual org sections.
850 #+begin_src emacs-lisp
852 :config (dash-enable-font-lock))
856 (setq diff-hl-draw-borders nil)
857 (global-diff-hl-mode)
858 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
862 :config (setq dired-listing-switches "-alh"))
865 :when (version< "25" emacs-version)
866 :config (global-eldoc-mode))
870 :config (temp-buffer-resize-mode))
873 (setq isearch-allow-scroll t))
875 (use-package lisp-mode
877 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
878 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
879 (defun indent-spaces-mode ()
880 (setq indent-tabs-mode nil))
881 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
885 :config (setq Man-width 80))
888 :config (show-paren-mode))
890 (use-package prog-mode
891 :config (global-prettify-symbols-mode)
892 (defun indicate-buffer-boundaries-left ()
893 (setq indicate-buffer-boundaries 'left))
894 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
898 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
900 (use-package savehist
901 :config (savehist-mode))
903 (use-package saveplace
904 :when (version< "25" emacs-version)
905 :config (save-place-mode))
908 :config (column-number-mode))
911 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
916 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
917 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
918 (add-to-list 'tramp-default-proxies-alist
919 (list (regexp-quote (system-name)) nil nil)))
921 (use-package undo-tree
922 :bind (("C-?" . undo-tree-undo)
923 ("M-_" . undo-tree-redo))
925 (global-undo-tree-mode)
926 (setq undo-tree-mode-lighter ""
927 undo-tree-auto-save-history t))
934 #+begin_src emacs-lisp
938 (:map company-active-map
939 ([tab] . company-complete-common-or-cycle))
941 (company-idle-delay 0.3)
942 (company-minimum-prefix-length 1)
943 (company-selection-wrap-around t)
944 (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
946 (global-company-mode t))
949 * Syntax and spell checking
950 #+begin_src emacs-lisp
951 (use-package flycheck
952 :hook (prog-mode . flycheck-mode)
954 ;; Use the load-path from running Emacs when checking elisp files
955 (setq flycheck-emacs-lisp-load-path 'inherit)
957 ;; Only flycheck when I actually save the buffer
958 (setq flycheck-check-syntax-automatically '(mode-enabled save)))
962 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
964 #+begin_src emacs-lisp
965 (use-package alloy-mode
966 :config (setq alloy-basic-offset 2))
969 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
971 #+begin_src emacs-lisp
972 (use-package proof-site ; Proof General
973 :load-path "lib/proof-site/generic/")
976 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
978 #+begin_src emacs-lisp
979 (eval-when-compile (defvar lean-mode-map))
980 (use-package lean-mode
981 :bind (:map lean-mode-map
982 ("S-SPC" . company-complete)))
987 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
989 #+begin_src emacs-lisp
990 (use-package haskell-mode
992 (setq haskell-indentation-layout-offset 4
993 haskell-indentation-left-offset 4
994 flycheck-checker 'haskell-hlint
995 flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
998 *** [[https://github.com/jyp/dante][dante]]
1000 #+begin_src emacs-lisp
1003 :commands dante-mode
1004 :hook (haskell-mode . dante-mode))
1007 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1009 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1010 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1012 #+begin_src emacs-lisp
1013 (use-package hlint-refactor
1014 :bind (:map hlint-refactor-mode-map
1015 ("C-c l b" . hlint-refactor-refactor-buffer)
1016 ("C-c l r" . hlint-refactor-refactor-at-point))
1017 :hook (haskell-mode . hlint-refactor-mode))
1020 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1022 #+begin_src emacs-lisp
1023 (use-package flycheck-haskell)
1026 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1028 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1031 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1034 #+begin_src emacs-lisp :tangle no
1035 ;;; hs-lint.el --- minor mode for HLint code checking
1037 ;; Copyright 2009 (C) Alex Ott
1039 ;; Author: Alex Ott <alexott@gmail.com>
1040 ;; Keywords: haskell, lint, HLint
1042 ;; Status: distributed under terms of GPL2 or above
1044 ;; Typical message from HLint looks like:
1046 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1048 ;; count1 p l = length (filter p l)
1050 ;; count1 p = length . filter p
1055 (defgroup hs-lint nil
1056 "Run HLint as inferior of Emacs, parse error messages."
1060 (defcustom hs-lint-command "hlint"
1061 "The default hs-lint command for \\[hlint]."
1065 (defcustom hs-lint-save-files t
1066 "Save modified files when run HLint or no (ask user)"
1070 (defcustom hs-lint-replace-with-suggestions nil
1071 "Replace user's code with suggested replacements"
1075 (defcustom hs-lint-replace-without-ask nil
1076 "Replace user's code with suggested replacements automatically"
1080 (defun hs-lint-process-setup ()
1081 "Setup compilation variables and buffer for `hlint'."
1082 (run-hooks 'hs-lint-setup-hook))
1084 ;; regex for replace suggestions
1086 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1092 (defvar hs-lint-regex
1093 "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1094 "Regex for HLint messages")
1096 (defun make-short-string (str maxlen)
1097 (if (< (length str) maxlen)
1099 (concat (substring str 0 (- maxlen 3)) "...")))
1101 (defun hs-lint-replace-suggestions ()
1102 "Perform actual replacement of suggestions"
1103 (goto-char (point-min))
1104 (while (re-search-forward hs-lint-regex nil t)
1105 (let* ((fname (match-string 1))
1106 (fline (string-to-number (match-string 2)))
1107 (old-code (match-string 4))
1108 (new-code (match-string 5))
1109 (msg (concat "Replace '" (make-short-string old-code 30)
1110 "' with '" (make-short-string new-code 30) "'"))
1116 (switch-to-buffer (get-file-buffer fname))
1117 (goto-char (point-min))
1118 (forward-line (1- fline))
1120 (setf bline (point))
1121 (when (or hs-lint-replace-without-ask
1124 (setf eline (point))
1126 (setf old-code (regexp-quote old-code))
1127 (while (string-match "\\\\ " old-code spos)
1128 (setf new-old-code (concat new-old-code
1129 (substring old-code spos (match-beginning 0))
1131 (setf spos (match-end 0)))
1132 (setf new-old-code (concat new-old-code (substring old-code spos)))
1133 (remove-text-properties bline eline '(composition nil))
1134 (when (re-search-forward new-old-code eline t)
1135 (replace-match new-code nil t)))))))
1137 (defun hs-lint-finish-hook (buf msg)
1138 "Function, that is executed at the end of HLint execution"
1139 (if hs-lint-replace-with-suggestions
1140 (hs-lint-replace-suggestions)
1143 (define-compilation-mode hs-lint-mode "HLint"
1144 "Mode for check Haskell source code."
1145 (set (make-local-variable 'compilation-process-setup-function)
1146 'hs-lint-process-setup)
1147 (set (make-local-variable 'compilation-disable-input) t)
1148 (set (make-local-variable 'compilation-scroll-output) nil)
1149 (set (make-local-variable 'compilation-finish-functions)
1150 (list 'hs-lint-finish-hook))
1154 "Run HLint for current buffer with haskell source"
1156 (save-some-buffers hs-lint-save-files)
1157 (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1161 ;;; hs-lint.el ends here
1164 #+begin_src emacs-lisp :tangle no
1165 (use-package hs-lint
1167 :bind (:map haskell-mode-map
1168 ("C-c l l" . hs-lint)))
1170 * Emacs Enhancements
1172 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1175 Emacs package that displays available keybindings in popup
1178 #+begin_src emacs-lisp
1179 (use-package which-key
1181 :config (which-key-mode))
1184 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1186 #+begin_src emacs-lisp
1187 (use-package doom-modeline
1189 :config (setq doom-modeline-height 32)
1190 :hook (after-init . doom-modeline-init))
1193 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1195 #+begin_src emacs-lisp :tangle no
1196 (use-package tao-theme
1198 :config (load-theme 'tao-yang t))
1201 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1203 #+begin_src emacs-lisp
1204 (load-theme 'eink t)
1207 ** [[https://github.com/bbatsov/crux][crux]]
1209 #+begin_src emacs-lisp
1211 :bind (("C-c d" . crux-duplicate-current-line-or-region)
1212 ("C-c M-d" . crux-duplicate-and-comment-current-line-or-region)
1213 ("C-c b K" . crux-kill-other-buffers)
1214 ("C-c f c" . crux-copy-file-preserve-attributes)
1215 ("C-c f D" . crux-delete-file-and-buffer)
1216 ("C-c f R" . crux-rename-file-and-buffer)
1217 ("C-S-j" . crux-top-join-line)
1218 ("C-c j" . crux-top-join-line)))
1221 ** [[https://github.com/alezost/mwim.el][mwim]]
1223 #+begin_src emacs-lisp
1225 :bind (("C-a" . mwim-beginning-of-code-or-line)
1226 ("C-e" . mwim-end-of-code-or-line)
1227 ("<home>" . mwim-beginning-of-line-or-code)
1228 ("<end>" . mwim-end-of-line-or-code)))
1233 #+begin_src emacs-lisp
1234 (use-package projectile
1236 :bind-keymap ("C-c p" . projectile-command-map)
1240 (defun my-projectile-invalidate-cache (&rest _args)
1241 ;; ignore the args to `magit-checkout'
1242 (projectile-invalidate-cache nil))
1244 (eval-after-load 'magit-branch
1246 (advice-add 'magit-checkout
1247 :after #'my-projectile-invalidate-cache)
1248 (advice-add 'magit-branch-and-checkout
1249 :after #'my-projectile-invalidate-cache))))
1252 ** [[https://github.com/wasamasa/shackle][shackle]]
1254 #+begin_src emacs-lisp
1255 (use-package shackle
1257 :commands shackle-mode
1261 '(("*Help*" :align right :select t :size 0.5)
1262 ("\\`\\*helm.*?\\*\\'" :regexp t :align t)
1263 ((compilation-mode "\\`\\*magit-diff: .*?\\'") :regexp t :noselect t)
1264 ("*magit-dispatch-popup*" :align bottom)
1265 ((inferior-scheme-mode "*shell*" "*eshell*") :popup t))
1266 shackle-default-rule '(:select t)
1267 shackle-default-size 0.4
1268 shackle-inhibit-window-quit-on-same-windows t))
1271 ** [[https://github.com/Wilfred/helpful][helpful]]
1273 #+begin_src emacs-lisp
1274 (use-package helpful
1276 (("C-h f" . helpful-callable)
1277 ("C-h v" . helpful-variable)
1278 ("C-h k" . helpful-key)
1279 ("C-c C-d" . helpful-at-point)
1280 ("C-h F" . helpful-function)
1281 ("C-h C" . helpful-command)))
1284 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1286 #+begin_src emacs-lisp
1287 (use-package shell-pop
1289 (add-to-list 'shackle-rules '("\\*eshell\\*" :regexp t :same t))
1291 (shell-pop-universal-key "C-c e")
1292 (shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1295 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1297 Make =*scratch*= and =*Messages*= unkillable.
1299 #+begin_src emacs-lisp
1300 (use-package unkillable-scratch
1302 (unkillable-scratch 1)
1304 (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1307 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1311 | make pretty boxed quotes like this
1315 #+begin_src emacs-lisp
1316 (use-package boxquote
1318 (:prefix-map amin--boxquote-prefix-map
1320 ("b" . boxquote-buffer)
1321 ("B" . boxquote-insert-buffer)
1322 ("d" . boxquote-defun)
1323 ("F" . boxquote-insert-file)
1324 ("hf" . boxquote-describe-function)
1325 ("hk" . boxquote-describe-key)
1326 ("hv" . boxquote-describe-variable)
1327 ("hw" . boxquote-where-is)
1328 ("k" . boxquote-kill)
1329 ("p" . boxquote-paragraph)
1330 ("q" . boxquote-boxquote)
1331 ("r" . boxquote-region)
1332 ("s" . boxquote-shell-command)
1333 ("t" . boxquote-text)
1334 ("T" . boxquote-title)
1335 ("u" . boxquote-unbox)
1336 ("U" . boxquote-unbox-region)
1337 ("y" . boxquote-yank)
1338 ("M-q" . boxquote-fill-paragraph)
1339 ("M-w" . boxquote-kill-ring-save)))
1342 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1345 ** [[https://notmuchmail.org][notmuch]]
1347 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1349 #+begin_src emacs-lisp
1350 (defvar amin-maildir "~/mail")
1352 (use-package sendmail
1355 (setq sendmail-program "/usr/bin/msmtp"
1356 ; message-sendmail-extra-arguments '("-v" "-d")
1357 mail-specify-envelope-from t
1358 mail-envelope-from 'header))
1360 (use-package message
1363 (setq message-kill-buffer-on-exit t
1364 message-send-mail-function 'message-send-mail-with-sendmail
1365 message-sendmail-envelope-from 'header
1366 message-directory "drafts"
1367 message-user-fqdn "aminb.org")
1368 (add-hook 'message-mode-hook
1369 (lambda () (setq fill-column 65
1370 message-fill-column 65)))
1371 (add-hook 'message-mode-hook
1373 ;; (add-hook 'notmuch-message-mode-hook #'+doom-modeline|set-special-modeline)
1374 ;; TODO: is there a way to only run this when replying and not composing?
1375 ;; (add-hook 'notmuch-message-mode-hook
1376 ;; (lambda () (progn
1379 ;; (forward-line -1)
1380 ;; (forward-line -1))))
1381 ;; (add-hook 'message-setup-hook
1382 ;; #'mml-secure-message-sign-pgpmime)
1386 (setq mml-secure-openpgp-encrypt-to-self t
1387 mml-secure-openpgp-sign-with-sender t))
1389 (defun amin/notmuch ()
1390 "Delete other windows, then launch `notmuch'."
1392 (delete-other-windows)
1395 (use-package notmuch
1397 :bind ("C-c m" . amin/notmuch)
1398 :custom (notmuch-always-prompt-for-sender t)
1400 (setq notmuch-hello-sections
1401 '(notmuch-hello-insert-header
1402 notmuch-hello-insert-saved-searches
1403 ;; notmuch-hello-insert-search
1404 notmuch-hello-insert-alltags)
1405 notmuch-search-oldest-first nil
1406 notmuch-show-all-tags-list t
1407 notmuch-message-headers ; see bug follow-up above
1408 '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1409 notmuch-hello-thousands-separator ","
1411 '(("amin@aminb.org" . "amin/Sent")
1412 ("amin@gnu.org" . "gnu/Sent")
1413 ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1414 ("mab@gnu.org" . "gnu/Sent")
1415 ("aminb@gnu.org" . "gnu/Sent")
1417 notmuch-search-result-format
1418 '(("date" . "%12s ")
1420 ("authors" . "%-40s ")
1423 notmuch-saved-searches
1424 '((:name "inbox" :query "tag:inbox" :key "i")
1425 (:name "unread" :query "tag:unread" :key "u")
1426 (:name "latest" :query "tag:latest" :key "l")
1427 (:name "encrypted" :query "tag:encrypted" :key "e")
1428 (:name "flagged" :query "tag:flagged" :key "f")
1429 (:name "sent" :query "tag:sent" :key "s")
1430 (:name "drafts" :query "tag:draft" :key "d")
1431 (:name "all mail" :query "*" :key "a")))
1432 ;; (add-hook 'visual-fill-column-mode-hook
1434 ;; (when (string= major-mode 'notmuch-message-mode)
1435 ;; (setq visual-fill-column-width 70))))
1436 ;; (set! :evil-state 'notmuch-message-mode 'insert)
1437 ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1438 ;; :override #'kill-this-buffer)
1440 (:map notmuch-hello-mode-map
1442 "Search for `unread'-tagged messages"
1444 (notmuch-hello-search "tag:unread")))
1446 "Search for `inbox'-tagged messages"
1448 (notmuch-hello-search "tag:inbox")))
1450 "Search for `latest'-tagged messages"
1452 (notmuch-hello-search "tag:latest")))
1454 "Search for `encrypted'-tagged messages"
1456 (notmuch-hello-search "tag:encrypted"))))
1457 (:map notmuch-search-mode-map
1461 (notmuch-search-tag '("-unread"))
1462 ;; (notmuch-search-archive-thread)
1463 (notmuch-search-next-thread)))
1465 "Mark message unread"
1467 (notmuch-search-tag '("+unread"))
1468 (notmuch-search-next-thread)))
1470 "Mark message deleted"
1472 (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1473 (notmuch-search-next-thread)))
1475 "Mark message as spam"
1477 (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1478 (notmuch-search-next-thread))))
1479 (:map notmuch-tree-mode-map
1483 (notmuch-tree-tag '("-unread"))
1484 ;; (notmuch-tree-archive-thread)
1485 (notmuch-tree-next-message)))
1487 "Mark message unread"
1489 (notmuch-tree-tag '("+unread"))
1490 (notmuch-tree-next-message)))
1492 "Mark message deleted"
1494 (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
1495 (notmuch-tree-next-message)))
1497 "Mark message as spam"
1499 (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1500 (notmuch-tree-next-message)))))
1502 (use-package counsel-notmuch
1503 :bind ("C-c s m" . counsel-notmuch))
1505 (after! notmuch-crypto
1506 (setq notmuch-crypto-process-mime t))
1509 (add-to-list 'recentf-exclude (expand-file-name amin-maildir)))
1514 #+begin_src emacs-lisp :tangle no
1515 (use-package supercite
1516 :commands sc-cite-original
1518 (add-hook 'mail-citation-hook 'sc-cite-original)
1520 (defun sc-remove-existing-signature ()
1522 (goto-char (region-beginning))
1523 (when (re-search-forward message-signature-separator (region-end) t)
1524 (delete-region (match-beginning 0) (region-end)))))
1526 (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1528 (defun sc-remove-if-not-mailing-list ()
1529 (unless (assoc "list-id" sc-mail-info)
1530 (setq attribution sc-default-attribution
1531 citation (concat sc-citation-delimiter
1532 sc-citation-separator))))
1534 (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1537 (defun sc-fill-if-different (&optional prefix)
1538 "Fill the region bounded by `sc-fill-begin' and point.
1539 Only fill if optional PREFIX is different than
1540 `sc-fill-line-prefix'. If `sc-auto-fill-region-p' is nil, do not
1541 fill region. If PREFIX is not supplied, initialize fill
1542 variables. This is useful for a regi `begin' frame-entry."
1544 (setq sc-fill-line-prefix ""
1545 sc-fill-begin (line-beginning-position))
1546 (if (and sc-auto-fill-region-p
1547 (not (string= prefix sc-fill-line-prefix)))
1548 (let ((fill-prefix sc-fill-line-prefix))
1549 (unless (or (string= fill-prefix "")
1551 (goto-char sc-fill-begin)
1552 (or (looking-at ">+ +")
1554 (buffer-substring (point)
1555 (line-end-position)))
1557 (fill-region sc-fill-begin (line-beginning-position)))
1558 (setq sc-fill-line-prefix prefix
1559 sc-fill-begin (line-beginning-position)))))
1564 ** [[https://ox-hugo.scripter.co][ox-hugo]]
1566 #+begin_src emacs-lisp
1567 (use-package ox-hugo
1571 * Post initialization
1573 :CUSTOM_ID: post-initialization
1576 Display how long it took to load the init file.
1578 #+begin_src emacs-lisp
1579 (message "Loading %s...done (%.3fs)" user-init-file
1580 (float-time (time-subtract (current-time)
1581 amin--before-user-init-time)))
1589 #+begin_src emacs-lisp :comments none
1590 ;;; init.el ends here
1593 * COMMENT Local Variables :ARCHIVE:
1595 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)