1 #+title: =aminb='s Literate Emacs Configuration
4 #+property: header-args :tangle yes
11 This org file is my literate configuration for GNU Emacs, and is
12 tangled to [[./init.el][init.el]]. Packages are installed and managed using
13 [[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of
14 many different people. Some of the configurations that I can remember
15 off the top of my head are:
17 - [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses
18 straight.el for managing packages
19 - [[https://github.com/dakra/dmacs][dakra/dmacs]]: literate Emacs configuration, using Borg for managing
21 - [[http://pages.sachachua.com/.emacs.d/Sacha.html][Sacha Chua's literate Emacs configuration]]
22 - [[https://github.com/dakrone/eos][dakrone/eos]]
23 - Ryan Rix's [[http://doc.rix.si/cce/cce.html][Complete Computing Environment]] ([[http://doc.rix.si/projects/fsem.html][about cce]])
24 - [[https://github.com/jwiegley/dot-emacs][jwiegley/dot-emacs]]: nix-based configuration
25 - [[https://github.com/wasamasa/dotemacs][wasamasa/dotemacs]]
26 - [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
28 I'd like to have a fully reproducible Emacs setup (part of the reason
29 why I store my configuration in this repository) but unfortunately out
30 of the box, that's not achievable with =package.el=, not currently
31 anyway. So, I've opted to use Borg. For what it's worth, I briefly
32 experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds
33 to my init time; which is unacceptable for me: I use Emacs as my
34 window manager (via EXWM) and coming from bspwm, I'm too used to
35 having fast startup times.
39 To use this config for your Emacs, first you need to clone this repo,
40 then bootstrap Borg, tell Borg to retrieve package submodules, and
41 byte-compiled the packages. Something along these lines should work:
43 #+begin_src sh :tangle no
44 git clone https://github.com/aminb/dotfiles ~/.emacs.d
51 * Contents :toc_1:noexport:
55 - [[#initial-setup][Initial setup]]
57 - [[#post-initialization][Post initialization]]
67 #+begin_src emacs-lisp :comments none
68 ;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
71 Enable =view-mode=, which both makes the file read-only (as a reminder
72 that =init.el= is an auto-generated file, not supposed to be edited),
73 and provides some convenient key bindings for browsing through the
78 #+begin_src emacs-lisp :comments none
79 ;; Copyright (C) 2018 Amin Bandali <amin@aminb.org>
81 ;; This program is free software: you can redistribute it and/or modify
82 ;; it under the terms of the GNU General Public License as published by
83 ;; the Free Software Foundation, either version 3 of the License, or
84 ;; (at your option) any later version.
86 ;; This program is distributed in the hope that it will be useful,
87 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
88 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
89 ;; GNU General Public License for more details.
91 ;; You should have received a copy of the GNU General Public License
92 ;; along with this program. If not, see <https://www.gnu.org/licenses/>.
97 #+begin_src emacs-lisp :comments none
100 ;; Emacs configuration of Amin Bandali, computer scientist and functional
103 ;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
106 ** Naming conventions
108 The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found
109 [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=.
111 #+begin_src emacs-lisp :comments none
112 ;; Naming conventions:
114 ;; ab-... public variables or non-interactive functions
115 ;; ab--... private anything (non-interactive), not safe for direct use
116 ;; ab/... an interactive function; safe for M-x or keybinding
117 ;; ab:... an evil operator, motion, or command
118 ;; ab|... a hook function
119 ;; ab*... an advising function
120 ;; ab@... a hydra command
126 :CUSTOM_ID: initial-setup
129 #+begin_src emacs-lisp :comments none
133 ** Emacs initialization
135 I'd like to do a couple of measurements of Emacs' startup time. First,
136 let's see how long Emacs takes to start up, before even loading
137 =init.el=, i.e. =user-init-file=:
139 #+begin_src emacs-lisp
140 (defvar ab--before-user-init-time (current-time)
141 "Value of `current-time' when Emacs begins loading `user-init-file'.")
142 (message "Loading Emacs...done (%.3fs)"
143 (float-time (time-subtract ab--before-user-init-time
147 Also, temporarily increase ~gc-cons-threshhold~ and
148 ~gc-cons-percentage~ during startup to reduce garbage collection
149 frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
150 startup time as well.
152 #+begin_src emacs-lisp
153 (defvar ab--gc-cons-threshold gc-cons-threshold)
154 (defvar ab--gc-cons-percentage gc-cons-percentage)
155 (defvar ab--file-name-handler-alist file-name-handler-alist)
156 (setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB
157 gc-cons-percentage 0.6
158 file-name-handler-alist nil
159 ;; sidesteps a bug when profiling with esup
160 esup-child-profile-require-level 0)
163 Of course, we'd like to set them back to their defaults once we're
166 #+begin_src emacs-lisp
170 (setq gc-cons-threshold ab--gc-cons-threshold
171 gc-cons-percentage ab--gc-cons-percentage
172 file-name-handler-alist ab--file-name-handler-alist)))
175 Increase the number of lines kept in message logs (the =*Messages*=
178 #+begin_src emacs-lisp
179 (setq message-log-max 20000)
182 Optionally, we could suppress some byte compiler warnings like below,
183 but for now I've decided to keep them enabled. See documentation for
184 ~byte-compile-warnings~ for more details.
186 #+begin_src emacs-lisp
187 ;; (setq byte-compile-warnings
188 ;; '(not free-vars unresolved noruntime lexical make-local))
191 ** Package management
195 I can do all my package management things with Borg, and don't need
196 Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
197 the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
199 #+begin_src emacs-lisp :tangle early-init.el
200 (setq package-enable-at-startup nil)
203 But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
204 right now), and even when released it'll be long before most distros
205 ship in their repos, I'll still put the old workaround with the
206 commented call to ~package-initialize~ here anyway.
208 #+begin_src emacs-lisp
209 (setq package-enable-at-startup nil)
210 ;; (package-initialize)
216 Assimilate Emacs packages as Git submodules
219 [[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
220 short, it creates a git submodule in =lib/= for each package, which
221 can then be managed with the help of Magit or other tools.
223 #+begin_src emacs-lisp
224 (setq user-init-file (or load-file-name buffer-file-name)
225 user-emacs-directory (file-name-directory user-init-file))
226 (add-to-list 'load-path
227 (expand-file-name "lib/borg" user-emacs-directory))
235 A use-package declaration for simplifying your .emacs
238 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
239 packages (in our case especially the latter) in a neatly organized way
240 and without compromising on performance.
242 #+begin_src emacs-lisp
243 (require 'use-package)
244 (if nil ; set to t when need to debug init
245 (setq use-package-verbose t
246 use-package-expand-minimally nil
247 use-package-compute-statistics t
249 (setq use-package-verbose nil
250 use-package-expand-minimally t))
256 Browse the Emacsmirror package database
259 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
260 database, low-level functions for querying the database, and a
261 =package.el=-like user interface for browsing the available packages.
263 #+begin_src emacs-lisp
268 ** No littering in =~/.emacs.d=
271 Help keeping ~/.emacs.d clean
274 By default, even for Emacs' built-in packages, the configuration files
275 and persistent data are all over the place. Use =no-littering= to help
278 #+begin_src emacs-lisp
279 (use-package no-littering
283 (add-to-list 'savehist-additional-variables 'kill-ring)
285 (setq auto-save-file-name-transforms
286 `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
289 ** Custom file (=custom.el=)
291 I'm not planning on using the custom file much, but even so, I
292 definitely don't want it mixing with =init.el=. So, here; let's give
293 it it's own file. While at it, treat themes as safe.
295 #+begin_src emacs-lisp
299 (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
300 (when (file-exists-p custom-file)
302 (setf custom-safe-themes t))
305 ** Better =$PATH= handling
307 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
310 #+begin_src emacs-lisp
311 (use-package exec-path-from-shell
314 (setq exec-path-from-shell-check-startup-files nil)
316 (exec-path-from-shell-initialize)
317 ;; while we're at it, let's fix access to our running ssh-agent
318 (exec-path-from-shell-copy-env "SSH_AGENT_PID")
319 (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
322 ** Only one custom theme at a time
324 #+begin_src emacs-lisp
325 (defadvice load-theme (before clear-previous-themes activate)
326 "Clear existing theme settings instead of layering them"
327 (mapc #'disable-theme custom-enabled-themes))
332 Start server if not already running. Alternatively, can be done by
333 issuing =emacs --daemon= in the terminal, which can be automated with
334 a systemd service or using =brew services start emacs= on macOS. I use
335 Emacs as my window manager (via EXWM), so I always start Emacs on
336 login; so starting the server from inside Emacs is good enough for me.
338 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
340 #+begin_src emacs-lisp
342 :config (or (server-running-p) (server-mode)))
347 Font stack with better unicode support, around =Ubuntu Mono= and
350 #+begin_src emacs-lisp
351 (dolist (ft (fontset-list))
355 (font-spec :name "Ubuntu Mono"))
359 (font-spec :name "DejaVu Sans Mono")
366 ;; :name "Symbola monospacified for DejaVu Sans Mono")
372 ;; (font-spec :name "DejaVu Sans Mono")
378 (font-spec :name "DejaVu Sans Mono" :size 14)
385 #+begin_src emacs-lisp
392 #+begin_src emacs-lisp
393 (defun ab-enlist (exp)
394 "Return EXP wrapped in a list, or as-is if already a list."
395 (if (listp exp) exp (list exp)))
397 ; from https://github.com/hlissner/doom-emacs/commit/589108fdb270f24a98ba6209f6955fe41530b3ef
398 (defmacro after! (features &rest body)
399 "A smart wrapper around `with-eval-after-load'. Supresses warnings during
401 (declare (indent defun) (debug t))
402 (list (if (or (not (bound-and-true-p byte-compile-current-file))
403 (dolist (next (ab-enlist features))
405 (require next nil :no-error)
406 (load next :no-message :no-error))))
409 (cond ((symbolp features)
410 `(eval-after-load ',features '(progn ,@body)))
411 ((and (consp features)
412 (memq (car features) '(:or :any)))
414 ,@(cl-loop for next in (cdr features)
415 collect `(after! ,next ,@body))))
416 ((and (consp features)
417 (memq (car features) '(:and :all)))
418 (dolist (next (cdr features))
419 (setq body `(after! ,next ,@body)))
422 `(after! (:all ,@features) ,@body)))))
432 *** Time and battery in mode-line
434 Enable displaying time and battery in the mode-line, since I'm not
435 using the Xfce panel anymore. Also, I don't need to see the load
436 average on a regular basis, so disable that.
438 #+begin_src emacs-lisp
442 (setq display-time-default-load-average nil)
449 (display-battery-mode))
454 Might want to set the fringe to a smaller value, especially if using
455 EXWM. I'm fine with the default for now.
457 #+begin_src emacs-lisp
458 ;; (fringe-mode '(3 . 1))
462 *** Disable disabled commands
464 Emacs disables some commands by default that could persumably be
465 confusing for novice users. Let's disable that.
467 #+begin_src emacs-lisp
468 (setq disabled-command-function nil)
473 Save what I copy into clipboard from other applications into Emacs'
474 kill-ring, which would allow me to still be able to easily access it
475 in case I kill (cut or copy) something else inside Emacs before
476 yanking (pasting) what I'd originally intended to.
478 #+begin_src emacs-lisp
479 (setq save-interprogram-paste-before-kill t)
484 #+begin_src emacs-lisp
485 (setq enable-recursive-minibuffers t
486 resize-mini-windows t)
489 *** Lazy-person-friendly yes/no prompts
491 Lazy people would prefer to type fewer keystrokes, especially for yes
492 or no questions. I'm lazy.
494 #+begin_src emacs-lisp
495 (defalias 'yes-or-no-p #'y-or-n-p)
498 *** Startup screen and =*scratch*=
500 Firstly, let Emacs know that I'd like to have =*scratch*= as my
503 #+begin_src emacs-lisp
504 (setq initial-buffer-choice t)
507 Now let's customize the =*scratch*= buffer a bit. First off, I don't
508 need the default hint.
510 #+begin_src emacs-lisp
511 (setq initial-scratch-message nil)
514 Also, let's use Text mode as the major mode, in case I want to
515 customize it (=*scratch*='s default major mode, Fundamental mode,
516 can't really be customized).
518 #+begin_src emacs-lisp
519 (setq initial-major-mode 'text-mode)
522 Inhibit the buffer list when more than 2 files are loaded.
524 #+begin_src emacs-lisp
525 (setq inhibit-startup-buffer-menu t)
528 I don't really need to see the startup screen or echo area message
531 #+begin_src emacs-lisp
532 (advice-add #'display-startup-echo-area-message :override #'ignore)
533 (setq inhibit-startup-screen t
534 inhibit-startup-echo-area-message user-login-name)
537 *** More useful frame titles
539 Show either the file name or the buffer name (in case the buffer isn't
540 visiting a file). Borrowed from Emacs Prelude.
542 #+begin_src emacs-lisp
543 (setq frame-title-format
544 '("" invocation-name " - "
545 (:eval (if (buffer-file-name)
546 (abbreviate-file-name (buffer-file-name))
552 Emacs' default backup settings aren't that great. Let's use more
553 sensible options. See documentation for the ~make-backup-file~
556 #+begin_src emacs-lisp
557 (setq backup-by-copying t
563 The packages in this section are absolutely essential to my everyday
564 workflow, and they play key roles in how I do my computing. They
565 immensely enhance the Emacs experience for me; both using Emacs, and
568 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
570 #+begin_src emacs-lisp
571 (use-package auto-compile
574 (auto-compile-on-load-mode)
575 (auto-compile-on-save-mode)
576 (setq auto-compile-display-buffer nil
577 auto-compile-mode-line-counter t
578 auto-compile-source-recreate-deletes-dest t
579 auto-compile-toggle-deletes-nonlib-dest t
580 auto-compile-update-autoloads t)
581 (add-hook 'auto-compile-inhibit-compile-hook
582 'auto-compile-inhibit-compile-detached-git-head))
585 *** [[https://github.com/noctuid/general.el][general]]
588 Roll your own modal mode
591 #+begin_src emacs-lisp
595 (general-evil-setup t)
597 (general-override-mode)
599 (general-create-definer
602 :states '(emacs normal visual motion insert)
603 :non-normal-prefix "C-,"
606 (general-create-definer
609 :states '(emacs normal visual motion insert)
610 :non-normal-prefix "M-m"
616 #+begin_src emacs-lisp
619 :hook (view-mode . evil-motion-state)
620 :config (evil-mode 1))
623 #+begin_src emacs-lisp
624 (use-package evil-escape
627 (setq evil-escape-excluded-states '(normal visual multiedit emacs motion)
628 evil-escape-excluded-major-modes '(neotree-mode)
629 evil-escape-key-sequence "jk"
630 evil-escape-delay 0.25)
632 (:states '(insert replace visual operator)
636 ;; no `evil-escape' in minibuffer
637 (push #'minibufferp evil-escape-inhibit-functions))
640 *** [[https://orgmode.org/][Org mode]]
643 Org mode is for keeping notes, maintaining TODO lists, planning
644 projects, and authoring documents with a fast and effective plain-text
648 In short, my favourite way of life.
650 #+begin_src emacs-lisp
651 (setq org-src-tab-acts-natively t
652 org-src-preserve-indentation nil
653 org-edit-src-content-indentation 0
654 org-html-divs '((preamble "header" "preamble")
655 (content "main" "content")
656 (postamble "footer" "postamble"))
657 org-html-doctype "html5"
658 org-html-html5-fancy t
659 org-html-postamble nil)
660 (add-hook 'org-mode-hook 'org-indent-mode)
661 (use-package htmlize)
662 (use-package org-notmuch
663 :after (:any org notmuch))
666 *** [[https://magit.vc/][Magit]]
669 It's Magit! A Git porcelain inside Emacs.
672 Not just how I do git, but /the/ way to do git.
674 #+begin_src emacs-lisp
676 :general (ab--leader-keys "g s" 'magit-status)
678 :bind (("s-g" . magit-status)
679 ("C-x g" . magit-status)
680 ("C-x M-g" . magit-dispatch-popup))
682 (magit-add-section-hook 'magit-status-sections-hook
683 'magit-insert-modules
684 'magit-insert-stashes
688 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
691 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
692 an overview, and more. Oh, man!
695 There's no way I could top that, so I won't attempt to.
699 #+begin_src emacs-lisp
703 (:map ivy-minibuffer-map
704 ([escape] . keyboard-escape-quit)
705 ;; ("C-j" . ivy-next-line)
706 ;; ("C-k" . ivy-previous-line)
707 ([S-up] . ivy-previous-history-element)
708 ([S-down] . ivy-next-history-element)
709 ("DEL" . ivy-backward-delete-char))
717 #+begin_src emacs-lisp
719 :general (:states 'normal "/" 'swiper)
720 :bind (([remap isearch-forward] . swiper)
721 ([remap isearch-backward] . swiper)))
726 #+begin_src emacs-lisp
729 :general (ab--leader-keys
730 "f r" 'counsel-recentf
732 "." 'counsel-find-file)
733 :bind (([remap execute-extended-command] . counsel-M-x)
734 ([remap find-file] . counsel-find-file)
735 ("s-r" . counsel-recentf)
736 :map minibuffer-local-map
737 ("C-r" . counsel-minibuffer-history))
740 (defalias 'locate #'counsel-locate))
743 * Borg's =layer/essentials=
745 TODO: break this giant source block down into individual org sections.
747 #+begin_src emacs-lisp
749 :config (dash-enable-font-lock))
753 (setq diff-hl-draw-borders nil)
754 (global-diff-hl-mode)
755 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
759 :config (setq dired-listing-switches "-alh"))
762 :when (version< "25" emacs-version)
763 :config (global-eldoc-mode))
767 :config (temp-buffer-resize-mode))
770 (setq isearch-allow-scroll t))
772 (use-package lisp-mode
774 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
775 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
776 (defun indent-spaces-mode ()
777 (setq indent-tabs-mode nil))
778 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
782 :config (setq Man-width 80))
785 :config (show-paren-mode))
787 (use-package prog-mode
788 :config (global-prettify-symbols-mode)
789 (defun indicate-buffer-boundaries-left ()
790 (setq indicate-buffer-boundaries 'left))
791 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
795 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
797 (use-package savehist
798 :config (savehist-mode))
800 (use-package saveplace
801 :when (version< "25" emacs-version)
802 :config (save-place-mode))
805 :config (column-number-mode))
808 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
813 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
814 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
815 (add-to-list 'tramp-default-proxies-alist
816 (list (regexp-quote (system-name)) nil nil)))
818 (use-package undo-tree
820 (global-undo-tree-mode)
821 (setq undo-tree-mode-lighter ""))
828 #+begin_src emacs-lisp
832 (:map company-active-map
833 ([tab] . company-complete-common-or-cycle))
835 (company-idle-delay 0.3)
836 (company-minimum-prefix-length 1)
837 (company-selection-wrap-around t)
838 (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
840 (global-company-mode t))
845 #+begin_src emacs-lisp
848 "b b" 'ivy-switch-buffer
849 "," 'ivy-switch-buffer
850 "b k" 'kill-this-buffer
851 "q q" 'evil-save-and-quit)
854 * Syntax and spell checking
855 #+begin_src emacs-lisp
856 (use-package flycheck
857 :hook (prog-mode . flycheck-mode)
859 ;; Use the load-path from running Emacs when checking elisp files
860 (setq flycheck-emacs-lisp-load-path 'inherit)
862 ;; Only flycheck when I actually save the buffer
863 (setq flycheck-check-syntax-automatically '(mode-enabled save)))
867 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
869 #+begin_src emacs-lisp
870 (use-package alloy-mode
871 :config (setq alloy-basic-offset 2))
874 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
876 #+begin_src emacs-lisp
877 (use-package proof-site ; Proof General
878 :load-path "lib/proof-site/generic/")
881 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
883 #+begin_src emacs-lisp
884 (use-package lean-mode
885 :bind (:map lean-mode-map
886 ("S-SPC" . company-complete)))
891 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
893 #+begin_src emacs-lisp
894 (use-package haskell-mode
896 (setq haskell-indentation-layout-offset 4
897 haskell-indentation-left-offset 4
898 flycheck-checker 'haskell-hlint
899 flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
902 *** [[https://github.com/jyp/dante][dante]]
904 #+begin_src emacs-lisp
908 :hook (haskell-mode . dante-mode))
911 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
913 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
914 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
916 #+begin_src emacs-lisp
917 (use-package hlint-refactor
918 :bind (:map hlint-refactor-mode-map
919 ("C-c l b" . hlint-refactor-refactor-buffer)
920 ("C-c l r" . hlint-refactor-refactor-at-point))
921 :hook (haskell-mode . hlint-refactor-mode))
924 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
926 #+begin_src emacs-lisp
927 (use-package flycheck-haskell)
930 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
932 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
935 Currently using =flycheck-haskell= with the =haskell-hlint= checker
938 #+begin_src emacs-lisp :tangle no
939 ;;; hs-lint.el --- minor mode for HLint code checking
941 ;; Copyright 2009 (C) Alex Ott
943 ;; Author: Alex Ott <alexott@gmail.com>
944 ;; Keywords: haskell, lint, HLint
946 ;; Status: distributed under terms of GPL2 or above
948 ;; Typical message from HLint looks like:
950 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
952 ;; count1 p l = length (filter p l)
954 ;; count1 p = length . filter p
959 (defgroup hs-lint nil
960 "Run HLint as inferior of Emacs, parse error messages."
964 (defcustom hs-lint-command "hlint"
965 "The default hs-lint command for \\[hlint]."
969 (defcustom hs-lint-save-files t
970 "Save modified files when run HLint or no (ask user)"
974 (defcustom hs-lint-replace-with-suggestions nil
975 "Replace user's code with suggested replacements"
979 (defcustom hs-lint-replace-without-ask nil
980 "Replace user's code with suggested replacements automatically"
984 (defun hs-lint-process-setup ()
985 "Setup compilation variables and buffer for `hlint'."
986 (run-hooks 'hs-lint-setup-hook))
988 ;; regex for replace suggestions
990 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
996 (defvar hs-lint-regex
997 "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
998 "Regex for HLint messages")
1000 (defun make-short-string (str maxlen)
1001 (if (< (length str) maxlen)
1003 (concat (substring str 0 (- maxlen 3)) "...")))
1005 (defun hs-lint-replace-suggestions ()
1006 "Perform actual replacement of suggestions"
1007 (goto-char (point-min))
1008 (while (re-search-forward hs-lint-regex nil t)
1009 (let* ((fname (match-string 1))
1010 (fline (string-to-number (match-string 2)))
1011 (old-code (match-string 4))
1012 (new-code (match-string 5))
1013 (msg (concat "Replace '" (make-short-string old-code 30)
1014 "' with '" (make-short-string new-code 30) "'"))
1020 (switch-to-buffer (get-file-buffer fname))
1021 (goto-char (point-min))
1022 (forward-line (1- fline))
1024 (setf bline (point))
1025 (when (or hs-lint-replace-without-ask
1028 (setf eline (point))
1030 (setf old-code (regexp-quote old-code))
1031 (while (string-match "\\\\ " old-code spos)
1032 (setf new-old-code (concat new-old-code
1033 (substring old-code spos (match-beginning 0))
1035 (setf spos (match-end 0)))
1036 (setf new-old-code (concat new-old-code (substring old-code spos)))
1037 (remove-text-properties bline eline '(composition nil))
1038 (when (re-search-forward new-old-code eline t)
1039 (replace-match new-code nil t)))))))
1041 (defun hs-lint-finish-hook (buf msg)
1042 "Function, that is executed at the end of HLint execution"
1043 (if hs-lint-replace-with-suggestions
1044 (hs-lint-replace-suggestions)
1047 (define-compilation-mode hs-lint-mode "HLint"
1048 "Mode for check Haskell source code."
1049 (set (make-local-variable 'compilation-process-setup-function)
1050 'hs-lint-process-setup)
1051 (set (make-local-variable 'compilation-disable-input) t)
1052 (set (make-local-variable 'compilation-scroll-output) nil)
1053 (set (make-local-variable 'compilation-finish-functions)
1054 (list 'hs-lint-finish-hook))
1058 "Run HLint for current buffer with haskell source"
1060 (save-some-buffers hs-lint-save-files)
1061 (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1065 ;;; hs-lint.el ends here
1068 #+begin_src emacs-lisp :tangle no
1069 (use-package hs-lint
1071 :bind (:map haskell-mode-map
1072 ("C-c l l" . hs-lint)))
1074 * Emacs Enhancements
1076 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1079 Emacs package that displays available keybindings in popup
1082 #+begin_src emacs-lisp
1083 (use-package which-key
1085 :config (which-key-mode))
1088 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1090 #+begin_src emacs-lisp
1091 (use-package doom-modeline
1093 :config (setq doom-modeline-height 32)
1094 :hook (after-init . doom-modeline-init))
1097 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1099 #+begin_src emacs-lisp :tangle no
1100 (use-package tao-theme
1102 :config (load-theme 'tao-yang t))
1105 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1107 #+begin_src emacs-lisp
1108 (load-theme 'eink t)
1112 ** [[https://notmuchmail.org][notmuch]]
1114 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1116 #+begin_src emacs-lisp
1117 (defun ab/notmuch ()
1118 "Delete other windows, then launch `notmuch'."
1121 (delete-other-windows)
1127 ;; "SPC" 'counsel-M-x)
1131 ;; :desc "notmuch" :n "m" #'ab/notmuch
1132 ;; (:desc "search" :prefix "/"
1133 ;; :desc "notmuch" :n "m" #'counsel-notmuch))
1136 #+begin_src emacs-lisp
1137 (defvar ab-maildir "~/mail")
1139 (use-package sendmail
1142 (setq sendmail-program "/usr/bin/msmtp"
1143 mail-specify-envelope-from t
1144 mail-envelope-from 'header))
1146 (use-package message
1149 (setq message-kill-buffer-on-exit t
1150 message-send-mail-function 'message-send-mail-with-sendmail
1151 message-sendmail-envelope-from 'header
1152 message-directory "drafts"
1153 message-user-fqdn "fencepost.gnu.org")
1154 (add-hook 'message-mode-hook
1155 (lambda () (setq fill-column 65
1156 message-fill-column 65)))
1157 (add-hook 'message-mode-hook
1159 ;; (add-hook 'notmuch-message-mode-hook #'+doom-modeline|set-special-modeline)
1160 ;; TODO: is there a way to only run this when replying and not composing?
1161 ;; (add-hook 'notmuch-message-mode-hook
1162 ;; (lambda () (progn
1165 ;; (forward-line -1)
1166 ;; (forward-line -1))))
1167 ;; (add-hook 'message-setup-hook
1168 ;; #'mml-secure-message-sign-pgpmime)
1172 (setq mml-secure-openpgp-encrypt-to-self t
1173 mml-secure-openpgp-sign-with-sender t))
1175 (use-package notmuch
1176 :general (ab--leader-keys "m" 'ab/notmuch)
1178 (setq notmuch-hello-sections
1179 '(notmuch-hello-insert-header
1180 notmuch-hello-insert-saved-searches
1181 ;; notmuch-hello-insert-search
1182 notmuch-hello-insert-alltags)
1183 notmuch-search-oldest-first nil
1184 notmuch-show-all-tags-list t
1185 notmuch-message-headers ; see bug follow-up above
1186 '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1187 notmuch-hello-thousands-separator ","
1189 '(("amin@aminb.org" . "amin/Sent")
1190 ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1191 ("amin.bandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1192 ("aminb@gnu.org" . "gnu/Sent")
1194 notmuch-search-result-format
1195 '(("date" . "%12s ")
1197 ("authors" . "%-40s ")
1200 ;; (add-hook 'visual-fill-column-mode-hook
1202 ;; (when (string= major-mode 'notmuch-message-mode)
1203 ;; (setq visual-fill-column-width 70))))
1204 ;; (set! :evil-state 'notmuch-message-mode 'insert)
1205 ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1206 ;; :override #'kill-this-buffer)
1208 (:map notmuch-hello-mode-map
1209 ("g" . notmuch-poll-and-refresh-this-buffer)
1211 "Search for `inbox' tagged messages"
1213 (notmuch-hello-search "tag:inbox")))
1215 "Search for `unread' tagged messages"
1217 (notmuch-hello-search "tag:unread")))
1219 "Compose new mail and prompt for sender"
1221 (let ((current-prefix-arg t))
1222 (call-interactively #'notmuch-mua-new-mail)))))
1223 (:map notmuch-search-mode-map
1224 ("g" . notmuch-poll-and-refresh-this-buffer)
1228 (notmuch-search-tag '("-unread"))
1229 ;; (notmuch-search-archive-thread)
1230 (notmuch-search-next-thread)))
1232 "Mark message unread"
1234 (notmuch-search-tag '("+unread"))
1235 (notmuch-search-next-thread)))
1237 "Mark message deleted"
1239 (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1240 (notmuch-search-archive-thread)))
1242 "Mark message as spam"
1244 (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1245 (notmuch-search-archive-thread))))
1246 (:map notmuch-tree-mode-map ; TODO: additional bindings
1248 "Mark message as spam"
1250 (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1251 (notmuch-tree-archive-thread))))
1254 ;; (use-package counsel-notmuch
1255 ;; :commands counsel-notmuch)
1257 (after! notmuch-crypto
1258 (setq notmuch-crypto-process-mime t))
1261 ;; (mapc (lambda (str) (evil-set-initial-state (car str) (cdr str)))
1262 ;; '((notmuch-hello-mode . emacs)
1263 ;; (notmuch-search-mode . emacs)
1264 ;; (notmuch-tree-mode . emacs))))
1267 (add-to-list 'recentf-exclude (expand-file-name ab-maildir)))
1272 #+begin_src emacs-lisp :tangle no
1273 (use-package supercite
1274 :commands sc-cite-original
1276 (add-hook 'mail-citation-hook 'sc-cite-original)
1278 (defun sc-remove-existing-signature ()
1280 (goto-char (region-beginning))
1281 (when (re-search-forward message-signature-separator (region-end) t)
1282 (delete-region (match-beginning 0) (region-end)))))
1284 (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1286 (defun sc-remove-if-not-mailing-list ()
1287 (unless (assoc "list-id" sc-mail-info)
1288 (setq attribution sc-default-attribution
1289 citation (concat sc-citation-delimiter
1290 sc-citation-separator))))
1292 (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1295 (defun sc-fill-if-different (&optional prefix)
1296 "Fill the region bounded by `sc-fill-begin' and point.
1297 Only fill if optional PREFIX is different than
1298 `sc-fill-line-prefix'. If `sc-auto-fill-region-p' is nil, do not
1299 fill region. If PREFIX is not supplied, initialize fill
1300 variables. This is useful for a regi `begin' frame-entry."
1302 (setq sc-fill-line-prefix ""
1303 sc-fill-begin (line-beginning-position))
1304 (if (and sc-auto-fill-region-p
1305 (not (string= prefix sc-fill-line-prefix)))
1306 (let ((fill-prefix sc-fill-line-prefix))
1307 (unless (or (string= fill-prefix "")
1309 (goto-char sc-fill-begin)
1310 (or (looking-at ">+ +")
1312 (buffer-substring (point)
1313 (line-end-position)))
1315 (fill-region sc-fill-begin (line-beginning-position)))
1316 (setq sc-fill-line-prefix prefix
1317 sc-fill-begin (line-beginning-position)))))
1321 * Post initialization
1323 :CUSTOM_ID: post-initialization
1326 Display how long it took to load the init file.
1328 #+begin_src emacs-lisp
1329 (message "Loading %s...done (%.3fs)" user-init-file
1330 (float-time (time-subtract (current-time)
1331 ab--before-user-init-time)))
1339 #+begin_src emacs-lisp :comments none
1340 ;;; init.el ends here