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
585 Enable automatic reloading of changed buffers and files.
587 #+begin_src emacs-lisp
588 (global-auto-revert-mode 1)
589 (setq auto-revert-verbose nil
590 global-auto-revert-non-file-buffers t)
593 *** Always use space for indentation
595 #+begin_src emacs-lisp
598 require-final-newline t
604 Enable =winner-mode=.
606 #+begin_src emacs-lisp
612 #+begin_src emacs-lisp
614 ("C-c b B" . ibuffer-list-buffers)
615 ("C-c b k" . kill-this-buffer)
616 ("C-c b s" . save-buffer)
617 ("C-c S" . save-buffer)
618 ("C-c o" . other-window)
619 ("C-c q q" . save-buffers-kill-terminal))
624 The packages in this section are absolutely essential to my everyday
625 workflow, and they play key roles in how I do my computing. They
626 immensely enhance the Emacs experience for me; both using Emacs, and
629 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
631 #+begin_src emacs-lisp
632 (use-package auto-compile
635 (auto-compile-on-load-mode)
636 (auto-compile-on-save-mode)
637 (setq auto-compile-display-buffer nil
638 auto-compile-mode-line-counter t
639 auto-compile-source-recreate-deletes-dest t
640 auto-compile-toggle-deletes-nonlib-dest t
641 auto-compile-update-autoloads t)
642 (add-hook 'auto-compile-inhibit-compile-hook
643 'auto-compile-inhibit-compile-detached-git-head))
646 *** [[https://orgmode.org/][Org mode]]
649 Org mode is for keeping notes, maintaining TODO lists, planning
650 projects, and authoring documents with a fast and effective plain-text
654 In short, my favourite way of life.
656 #+begin_src emacs-lisp
659 (setq org-src-tab-acts-natively t
660 org-src-preserve-indentation nil
661 org-edit-src-content-indentation 0)
662 :hook (org-mode . org-indent-mode))
664 (use-package org-notmuch
665 :after (:any org notmuch))
668 *** [[https://magit.vc/][Magit]]
671 It's Magit! A Git porcelain inside Emacs.
674 Not just how I do git, but /the/ way to do git.
676 #+begin_src emacs-lisp
680 (("s-g" . magit-dispatch-popup)
681 ("C-x g" . magit-status)
682 :prefix-map amin--magit-prefix-map
684 ("SPC" . magit-status)
686 ("S" . magit-status-prefix)
692 ("p" . magit-dispatch-popup)
693 ("c c" . magit-commit)
694 ("c a" . magit-commit-amend)
695 ("b b" . magit-checkout)
696 ("b c" . magit-branch))
698 (magit-add-section-hook 'magit-status-sections-hook
699 'magit-insert-modules
700 'magit-insert-stashes
704 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
707 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
708 an overview, and more. Oh, man!
711 There's no way I could top that, so I won't attempt to.
715 #+begin_src emacs-lisp
719 (("C-c b b" . ivy-switch-buffer)
720 :map ivy-minibuffer-map
721 ([escape] . keyboard-escape-quit)
722 ([S-up] . ivy-previous-history-element)
723 ([S-down] . ivy-next-history-element)
724 ("DEL" . ivy-backward-delete-char))
732 #+begin_src emacs-lisp
734 :bind (([remap isearch-forward] . swiper)
735 ([remap isearch-backward] . swiper)))
740 #+begin_src emacs-lisp
743 :bind (([remap execute-extended-command] . counsel-M-x)
744 ([remap find-file] . counsel-find-file)
745 ("s-r" . counsel-recentf)
746 ("C-c x" . counsel-M-x)
747 ("C-c f ." . counsel-find-file)
748 ("C-c f r" . counsel-recentf)
749 :map minibuffer-local-map
750 ("C-r" . counsel-minibuffer-history))
753 (defalias 'locate #'counsel-locate))
758 #+begin_src emacs-lisp
762 (eval-when-compile (defvar eshell-prompt-regexp))
763 (defun amin/eshell-quit-or-delete-char (arg)
765 (if (and (eolp) (looking-back eshell-prompt-regexp nil))
766 (eshell-life-is-too-much)
769 (defun amin|eshell-setup ()
770 (bind-keys :map eshell-mode-map
771 ("C-d" . amin/eshell-quit-or-delete-char)))
773 :hook (eshell-mode . amin|eshell-setup))
776 * Borg's =layer/essentials=
778 TODO: break this giant source block down into individual org sections.
780 #+begin_src emacs-lisp
782 :config (dash-enable-font-lock))
786 (setq diff-hl-draw-borders nil)
787 (global-diff-hl-mode)
788 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
792 :config (setq dired-listing-switches "-alh"))
795 :when (version< "25" emacs-version)
796 :config (global-eldoc-mode))
800 :config (temp-buffer-resize-mode))
803 (setq isearch-allow-scroll t))
805 (use-package lisp-mode
807 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
808 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
809 (defun indent-spaces-mode ()
810 (setq indent-tabs-mode nil))
811 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
815 :config (setq Man-width 80))
818 :config (show-paren-mode))
820 (use-package prog-mode
821 :config (global-prettify-symbols-mode)
822 (defun indicate-buffer-boundaries-left ()
823 (setq indicate-buffer-boundaries 'left))
824 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
828 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
830 (use-package savehist
831 :config (savehist-mode))
833 (use-package saveplace
834 :when (version< "25" emacs-version)
835 :config (save-place-mode))
838 :config (column-number-mode))
841 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
846 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
847 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
848 (add-to-list 'tramp-default-proxies-alist
849 (list (regexp-quote (system-name)) nil nil)))
851 (use-package undo-tree
852 :bind (("C-?" . undo-tree-undo)
853 ("M-_" . undo-tree-redo))
855 (global-undo-tree-mode)
856 (setq undo-tree-mode-lighter ""
857 undo-tree-auto-save-history t))
864 #+begin_src emacs-lisp
868 (:map company-active-map
869 ([tab] . company-complete-common-or-cycle))
871 (company-idle-delay 0.3)
872 (company-minimum-prefix-length 1)
873 (company-selection-wrap-around t)
874 (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
876 (global-company-mode t))
879 * Syntax and spell checking
880 #+begin_src emacs-lisp
881 (use-package flycheck
882 :hook (prog-mode . flycheck-mode)
884 ;; Use the load-path from running Emacs when checking elisp files
885 (setq flycheck-emacs-lisp-load-path 'inherit)
887 ;; Only flycheck when I actually save the buffer
888 (setq flycheck-check-syntax-automatically '(mode-enabled save)))
892 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
894 #+begin_src emacs-lisp
895 (use-package alloy-mode
896 :config (setq alloy-basic-offset 2))
899 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
901 #+begin_src emacs-lisp
902 (use-package proof-site ; Proof General
903 :load-path "lib/proof-site/generic/")
906 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
908 #+begin_src emacs-lisp
909 (eval-when-compile (defvar lean-mode-map))
910 (use-package lean-mode
911 :bind (:map lean-mode-map
912 ("S-SPC" . company-complete)))
917 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
919 #+begin_src emacs-lisp
920 (use-package haskell-mode
922 (setq haskell-indentation-layout-offset 4
923 haskell-indentation-left-offset 4
924 flycheck-checker 'haskell-hlint
925 flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
928 *** [[https://github.com/jyp/dante][dante]]
930 #+begin_src emacs-lisp
934 :hook (haskell-mode . dante-mode))
937 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
939 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
940 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
942 #+begin_src emacs-lisp
943 (use-package hlint-refactor
944 :bind (:map hlint-refactor-mode-map
945 ("C-c l b" . hlint-refactor-refactor-buffer)
946 ("C-c l r" . hlint-refactor-refactor-at-point))
947 :hook (haskell-mode . hlint-refactor-mode))
950 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
952 #+begin_src emacs-lisp
953 (use-package flycheck-haskell)
956 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
958 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
961 Currently using =flycheck-haskell= with the =haskell-hlint= checker
964 #+begin_src emacs-lisp :tangle no
965 ;;; hs-lint.el --- minor mode for HLint code checking
967 ;; Copyright 2009 (C) Alex Ott
969 ;; Author: Alex Ott <alexott@gmail.com>
970 ;; Keywords: haskell, lint, HLint
972 ;; Status: distributed under terms of GPL2 or above
974 ;; Typical message from HLint looks like:
976 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
978 ;; count1 p l = length (filter p l)
980 ;; count1 p = length . filter p
985 (defgroup hs-lint nil
986 "Run HLint as inferior of Emacs, parse error messages."
990 (defcustom hs-lint-command "hlint"
991 "The default hs-lint command for \\[hlint]."
995 (defcustom hs-lint-save-files t
996 "Save modified files when run HLint or no (ask user)"
1000 (defcustom hs-lint-replace-with-suggestions nil
1001 "Replace user's code with suggested replacements"
1005 (defcustom hs-lint-replace-without-ask nil
1006 "Replace user's code with suggested replacements automatically"
1010 (defun hs-lint-process-setup ()
1011 "Setup compilation variables and buffer for `hlint'."
1012 (run-hooks 'hs-lint-setup-hook))
1014 ;; regex for replace suggestions
1016 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1022 (defvar hs-lint-regex
1023 "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1024 "Regex for HLint messages")
1026 (defun make-short-string (str maxlen)
1027 (if (< (length str) maxlen)
1029 (concat (substring str 0 (- maxlen 3)) "...")))
1031 (defun hs-lint-replace-suggestions ()
1032 "Perform actual replacement of suggestions"
1033 (goto-char (point-min))
1034 (while (re-search-forward hs-lint-regex nil t)
1035 (let* ((fname (match-string 1))
1036 (fline (string-to-number (match-string 2)))
1037 (old-code (match-string 4))
1038 (new-code (match-string 5))
1039 (msg (concat "Replace '" (make-short-string old-code 30)
1040 "' with '" (make-short-string new-code 30) "'"))
1046 (switch-to-buffer (get-file-buffer fname))
1047 (goto-char (point-min))
1048 (forward-line (1- fline))
1050 (setf bline (point))
1051 (when (or hs-lint-replace-without-ask
1054 (setf eline (point))
1056 (setf old-code (regexp-quote old-code))
1057 (while (string-match "\\\\ " old-code spos)
1058 (setf new-old-code (concat new-old-code
1059 (substring old-code spos (match-beginning 0))
1061 (setf spos (match-end 0)))
1062 (setf new-old-code (concat new-old-code (substring old-code spos)))
1063 (remove-text-properties bline eline '(composition nil))
1064 (when (re-search-forward new-old-code eline t)
1065 (replace-match new-code nil t)))))))
1067 (defun hs-lint-finish-hook (buf msg)
1068 "Function, that is executed at the end of HLint execution"
1069 (if hs-lint-replace-with-suggestions
1070 (hs-lint-replace-suggestions)
1073 (define-compilation-mode hs-lint-mode "HLint"
1074 "Mode for check Haskell source code."
1075 (set (make-local-variable 'compilation-process-setup-function)
1076 'hs-lint-process-setup)
1077 (set (make-local-variable 'compilation-disable-input) t)
1078 (set (make-local-variable 'compilation-scroll-output) nil)
1079 (set (make-local-variable 'compilation-finish-functions)
1080 (list 'hs-lint-finish-hook))
1084 "Run HLint for current buffer with haskell source"
1086 (save-some-buffers hs-lint-save-files)
1087 (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1091 ;;; hs-lint.el ends here
1094 #+begin_src emacs-lisp :tangle no
1095 (use-package hs-lint
1097 :bind (:map haskell-mode-map
1098 ("C-c l l" . hs-lint)))
1100 * Emacs Enhancements
1102 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1105 Emacs package that displays available keybindings in popup
1108 #+begin_src emacs-lisp
1109 (use-package which-key
1111 :config (which-key-mode))
1114 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1116 #+begin_src emacs-lisp
1117 (use-package doom-modeline
1119 :config (setq doom-modeline-height 32)
1120 :hook (after-init . doom-modeline-init))
1123 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1125 #+begin_src emacs-lisp :tangle no
1126 (use-package tao-theme
1128 :config (load-theme 'tao-yang t))
1131 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1133 #+begin_src emacs-lisp
1134 (load-theme 'eink t)
1137 ** [[https://github.com/bbatsov/crux][crux]]
1139 #+begin_src emacs-lisp
1141 :bind (("C-c d" . crux-duplicate-current-line-or-region)
1142 ("C-c M-d" . crux-duplicate-and-comment-current-line-or-region)
1143 ("C-c b K" . crux-kill-other-buffers)
1144 ("C-c f c" . crux-copy-file-preserve-attributes)
1145 ("C-c f D" . crux-delete-file-and-buffer)
1146 ("C-c f R" . crux-rename-file-and-buffer)))
1149 ** [[https://github.com/alezost/mwim.el][mwim]]
1151 #+begin_src emacs-lisp
1153 :bind (("C-a" . mwim-beginning-of-code-or-line)
1154 ("C-e" . mwim-end-of-code-or-line)
1155 ("<home>" . mwim-beginning-of-line-or-code)
1156 ("<end>" . mwim-end-of-line-or-code)))
1161 #+begin_src emacs-lisp
1162 (use-package projectile
1164 :bind-keymap ("C-c p" . projectile-command-map)
1168 (defun my-projectile-invalidate-cache (&rest _args)
1169 ;; ignore the args to `magit-checkout'
1170 (projectile-invalidate-cache nil))
1172 (eval-after-load 'magit-branch
1174 (advice-add 'magit-checkout
1175 :after #'my-projectile-invalidate-cache)
1176 (advice-add 'magit-branch-and-checkout
1177 :after #'my-projectile-invalidate-cache))))
1180 ** [[https://github.com/wasamasa/shackle][shackle]]
1182 #+begin_src emacs-lisp
1183 (use-package shackle
1185 :commands shackle-mode
1189 '(("*Help*" :align right :select t :size 0.5)
1190 ("\\`\\*helm.*?\\*\\'" :regexp t :align t)
1191 ((compilation-mode "\\`\\*magit-diff: .*?\\'") :regexp t :noselect t)
1192 ((inferior-scheme-mode "*shell*" "*eshell*") :popup t))
1193 shackle-default-rule '(:select t)
1194 shackle-default-size 0.4
1195 shackle-inhibit-window-quit-on-same-windows t))
1198 ** [[https://github.com/Wilfred/helpful][helpful]]
1200 #+begin_src emacs-lisp
1201 (use-package helpful
1203 (("C-h f" . helpful-callable)
1204 ("C-h v" . helpful-variable)
1205 ("C-h k" . helpful-key)
1206 ("C-c C-d" . helpful-at-point)
1207 ("C-h F" . helpful-function)
1208 ("C-h C" . helpful-command)))
1212 ** [[https://notmuchmail.org][notmuch]]
1214 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1216 #+begin_src emacs-lisp
1217 (defvar amin-maildir "~/mail")
1219 (use-package sendmail
1222 (setq sendmail-program "/usr/bin/msmtp"
1223 ; message-sendmail-extra-arguments '("-v" "-d")
1224 mail-specify-envelope-from t
1225 mail-envelope-from 'header))
1227 (use-package message
1230 (setq message-kill-buffer-on-exit t
1231 message-send-mail-function 'message-send-mail-with-sendmail
1232 message-sendmail-envelope-from 'header
1233 message-directory "drafts"
1234 message-user-fqdn "aminb.org")
1235 (add-hook 'message-mode-hook
1236 (lambda () (setq fill-column 65
1237 message-fill-column 65)))
1238 (add-hook 'message-mode-hook
1240 ;; (add-hook 'notmuch-message-mode-hook #'+doom-modeline|set-special-modeline)
1241 ;; TODO: is there a way to only run this when replying and not composing?
1242 ;; (add-hook 'notmuch-message-mode-hook
1243 ;; (lambda () (progn
1246 ;; (forward-line -1)
1247 ;; (forward-line -1))))
1248 ;; (add-hook 'message-setup-hook
1249 ;; #'mml-secure-message-sign-pgpmime)
1253 (setq mml-secure-openpgp-encrypt-to-self t
1254 mml-secure-openpgp-sign-with-sender t))
1256 (defun amin/notmuch ()
1257 "Delete other windows, then launch `notmuch'."
1259 (delete-other-windows)
1262 (use-package notmuch
1264 :bind ("C-c m" . amin/notmuch)
1265 :custom (notmuch-always-prompt-for-sender t)
1267 (setq notmuch-hello-sections
1268 '(notmuch-hello-insert-header
1269 notmuch-hello-insert-saved-searches
1270 ;; notmuch-hello-insert-search
1271 notmuch-hello-insert-alltags)
1272 notmuch-search-oldest-first nil
1273 notmuch-show-all-tags-list t
1274 notmuch-message-headers ; see bug follow-up above
1275 '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1276 notmuch-hello-thousands-separator ","
1278 '(("amin@aminb.org" . "amin/Sent")
1279 ("amin@gnu.org" . "gnu/Sent")
1280 ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1281 ("mab@gnu.org" . "gnu/Sent")
1282 ("aminb@gnu.org" . "gnu/Sent")
1284 notmuch-search-result-format
1285 '(("date" . "%12s ")
1287 ("authors" . "%-40s ")
1290 notmuch-saved-searches
1291 '((:name "inbox" :query "tag:inbox" :key "i")
1292 (:name "unread" :query "tag:unread" :key "u")
1293 (:name "latest" :query "tag:latest" :key "l")
1294 (:name "encrypted" :query "tag:encrypted" :key "e")
1295 (:name "flagged" :query "tag:flagged" :key "f")
1296 (:name "sent" :query "tag:sent" :key "s")
1297 (:name "drafts" :query "tag:draft" :key "d")
1298 (:name "all mail" :query "*" :key "a")))
1299 ;; (add-hook 'visual-fill-column-mode-hook
1301 ;; (when (string= major-mode 'notmuch-message-mode)
1302 ;; (setq visual-fill-column-width 70))))
1303 ;; (set! :evil-state 'notmuch-message-mode 'insert)
1304 ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1305 ;; :override #'kill-this-buffer)
1307 (:map notmuch-hello-mode-map
1309 "Search for `unread'-tagged messages"
1311 (notmuch-hello-search "tag:unread")))
1313 "Search for `inbox'-tagged messages"
1315 (notmuch-hello-search "tag:inbox")))
1317 "Search for `latest'-tagged messages"
1319 (notmuch-hello-search "tag:latest")))
1321 "Search for `encrypted'-tagged messages"
1323 (notmuch-hello-search "tag:encrypted"))))
1324 (:map notmuch-search-mode-map
1328 (notmuch-search-tag '("-unread"))
1329 ;; (notmuch-search-archive-thread)
1330 (notmuch-search-next-thread)))
1332 "Mark message unread"
1334 (notmuch-search-tag '("+unread"))
1335 (notmuch-search-next-thread)))
1337 "Mark message deleted"
1339 (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1340 (notmuch-search-next-thread)))
1342 "Mark message as spam"
1344 (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1345 (notmuch-search-next-thread))))
1346 (:map notmuch-tree-mode-map
1350 (notmuch-tree-tag '("-unread"))
1351 ;; (notmuch-tree-archive-thread)
1352 (notmuch-tree-next-message)))
1354 "Mark message unread"
1356 (notmuch-tree-tag '("+unread"))
1357 (notmuch-tree-next-message)))
1359 "Mark message deleted"
1361 (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
1362 (notmuch-tree-next-message)))
1364 "Mark message as spam"
1366 (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1367 (notmuch-tree-next-message)))))
1369 (use-package counsel-notmuch
1370 :bind ("C-c s m" . counsel-notmuch))
1372 (after! notmuch-crypto
1373 (setq notmuch-crypto-process-mime t))
1376 (add-to-list 'recentf-exclude (expand-file-name amin-maildir)))
1381 #+begin_src emacs-lisp :tangle no
1382 (use-package supercite
1383 :commands sc-cite-original
1385 (add-hook 'mail-citation-hook 'sc-cite-original)
1387 (defun sc-remove-existing-signature ()
1389 (goto-char (region-beginning))
1390 (when (re-search-forward message-signature-separator (region-end) t)
1391 (delete-region (match-beginning 0) (region-end)))))
1393 (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1395 (defun sc-remove-if-not-mailing-list ()
1396 (unless (assoc "list-id" sc-mail-info)
1397 (setq attribution sc-default-attribution
1398 citation (concat sc-citation-delimiter
1399 sc-citation-separator))))
1401 (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1404 (defun sc-fill-if-different (&optional prefix)
1405 "Fill the region bounded by `sc-fill-begin' and point.
1406 Only fill if optional PREFIX is different than
1407 `sc-fill-line-prefix'. If `sc-auto-fill-region-p' is nil, do not
1408 fill region. If PREFIX is not supplied, initialize fill
1409 variables. This is useful for a regi `begin' frame-entry."
1411 (setq sc-fill-line-prefix ""
1412 sc-fill-begin (line-beginning-position))
1413 (if (and sc-auto-fill-region-p
1414 (not (string= prefix sc-fill-line-prefix)))
1415 (let ((fill-prefix sc-fill-line-prefix))
1416 (unless (or (string= fill-prefix "")
1418 (goto-char sc-fill-begin)
1419 (or (looking-at ">+ +")
1421 (buffer-substring (point)
1422 (line-end-position)))
1424 (fill-region sc-fill-begin (line-beginning-position)))
1425 (setq sc-fill-line-prefix prefix
1426 sc-fill-begin (line-beginning-position)))))
1431 ** [[https://ox-hugo.scripter.co][ox-hugo]]
1433 #+begin_src emacs-lisp
1434 (use-package ox-hugo
1438 * Post initialization
1440 :CUSTOM_ID: post-initialization
1443 Display how long it took to load the init file.
1445 #+begin_src emacs-lisp
1446 (message "Loading %s...done (%.3fs)" user-init-file
1447 (float-time (time-subtract (current-time)
1448 amin--before-user-init-time)))
1456 #+begin_src emacs-lisp :comments none
1457 ;;; init.el ends here