git.shemshak.org - ~bandali/configs/blob - init.org

   1 #+title: =aminb='s Literate Emacs Configuration
   2 #+author: Amin Bandali
   3 #+babel: :cache yes
   4 #+property: header-args :tangle yes
   5
   6 * About
   7 :PROPERTIES:
   8 :CUSTOM_ID: about
   9 :END:
  10
  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:
  16
  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
  20   packages
  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]]
  27
  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.
  36
  37 ** Installation
  38
  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:
  42
  43 #+begin_src sh :tangle no
  44 git clone https://github.com/aminb/dotfiles ~/.emacs.d
  45 cd ~/.emacs.d
  46 make bootstrap-borg
  47 make bootstrap
  48 make build
  49 #+end_src
  50
  51 * Contents                                                   :toc_1:noexport:
  52
  53 - [[#about][About]]
  54 - [[#header][Header]]
  55 - [[#initial-setup][Initial setup]]
  56 - [[#core][Core]]
  57 - [[#post-initialization][Post initialization]]
  58 - [[#footer][Footer]]
  59
  60 * Header
  61 :PROPERTIES:
  62 :CUSTOM_ID: header
  63 :END:
  64
  65 ** First line
  66
  67 #+begin_src emacs-lisp :comments none
  68 ;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
  69 #+end_src
  70
  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
  74 file.
  75
  76 ** License
  77
  78 #+begin_src emacs-lisp :comments none
  79 ;; Copyright (C) 2018  Amin Bandali <amin@aminb.org>
  80
  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.
  85
  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.
  90
  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/>.
  93 #+end_src
  94
  95 ** Commentary
  96
  97 #+begin_src emacs-lisp :comments none
  98 ;;; Commentary:
  99
 100 ;; Emacs configuration of Amin Bandali, computer scientist and functional
 101 ;; programmer.
 102
 103 ;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
 104 #+end_src
 105
 106 ** Naming conventions
 107
 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]].
 109
 110 #+begin_src emacs-lisp :comments none
 111 ;; Naming conventions:
 112 ;;
 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
 120 ;;   ...!       a macro
 121 #+end_src
 122
 123 * Initial setup
 124 :PROPERTIES:
 125 :CUSTOM_ID: initial-setup
 126 :END:
 127
 128 #+begin_src emacs-lisp :comments none
 129 ;;; Code:
 130 #+end_src
 131
 132 ** Emacs initialization
 133
 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=:
 137
 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
 143                                     before-init-time)))
 144 #+end_src
 145
 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.
 150
 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)
 160 #+end_src
 161
 162 Of course, we'd like to set them back to their defaults once we're
 163 done initializing.
 164
 165 #+begin_src emacs-lisp
 166 (add-hook
 167  'after-init-hook
 168  (lambda ()
 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)))
 172 #+end_src
 173
 174 Increase the number of lines kept in message logs (the =*Messages*=
 175 buffer).
 176
 177 #+begin_src emacs-lisp
 178 (setq message-log-max 20000)
 179 #+end_src
 180
 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.
 184
 185 #+begin_src emacs-lisp
 186 ;; (setq byte-compile-warnings
 187 ;;       '(not free-vars unresolved noruntime lexical make-local))
 188 #+end_src
 189
 190 ** whoami
 191
 192 #+begin_src emacs-lisp
 193 (setq user-full-name "Amin Bandali"
 194       user-mail-address "amin@aminb.org")
 195 #+end_src
 196
 197 ** Package management
 198
 199 *** No =package.el=
 200
 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]]).
 204
 205 #+begin_src emacs-lisp :tangle early-init.el
 206 (setq package-enable-at-startup nil)
 207 #+end_src
 208
 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.
 213
 214 #+begin_src emacs-lisp
 215 (setq package-enable-at-startup nil)
 216 ;; (package-initialize)
 217 #+end_src
 218
 219 *** Borg
 220
 221 #+begin_quote
 222 Assimilate Emacs packages as Git submodules
 223 #+end_quote
 224
 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.
 228
 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))
 234 (require 'borg)
 235 (borg-initialize)
 236
 237 ;; (require 'borg-nix-shell)
 238 ;; (setq borg-build-shell-command 'borg-nix-shell-build-command)
 239
 240 (with-eval-after-load 'bind-key
 241   (bind-keys
 242    :package borg
 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)
 247    ("C-c b m" . borg-insert-update-message)
 248    ("C-c b r" . borg-remove)))
 249 #+end_src
 250
 251 *** =use-package=
 252
 253 #+begin_quote
 254 A use-package declaration for simplifying your .emacs
 255 #+end_quote
 256
 257 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
 258 packages (in our case especially the latter) in a neatly organized way
 259 and without compromising on performance.
 260
 261 #+begin_src emacs-lisp
 262 (require 'use-package)
 263 (if nil  ; set to t when need to debug init
 264     (setq use-package-verbose t
 265           use-package-expand-minimally nil
 266           use-package-compute-statistics t
 267           debug-on-error t)
 268   (setq use-package-verbose nil
 269         use-package-expand-minimally t))
 270 #+end_src
 271
 272 *** Epkg
 273
 274 #+begin_quote
 275 Browse the Emacsmirror package database
 276 #+end_quote
 277
 278 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
 279 database, low-level functions for querying the database, and a
 280 =package.el=-like user interface for browsing the available packages.
 281
 282 #+begin_src emacs-lisp
 283 (use-package epkg
 284   :defer t
 285   :bind
 286   (("C-c b d" . epkg-describe-package)
 287    ("C-c b p" . epkg-list-packages)
 288    ("C-c b u" . epkg-update)))
 289 #+end_src
 290
 291 ** No littering in =~/.emacs.d=
 292
 293 #+begin_quote
 294 Help keeping ~/.emacs.d clean
 295 #+end_quote
 296
 297 By default, even for Emacs' built-in packages, the configuration files
 298 and persistent data are all over the place. Use =no-littering= to help
 299 contain the mess.
 300
 301 #+begin_src emacs-lisp
 302 (use-package no-littering
 303   :demand t
 304   :config
 305   (savehist-mode 1)
 306   (add-to-list 'savehist-additional-variables 'kill-ring)
 307   (save-place-mode 1)
 308   (setq auto-save-file-name-transforms
 309         `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
 310 #+end_src
 311
 312 ** Custom file (=custom.el=)
 313
 314 I'm not planning on using the custom file much, but even so, I
 315 definitely don't want it mixing with =init.el=. So, here; let's give
 316 it it's own file. While at it, treat themes as safe.
 317
 318 #+begin_src emacs-lisp
 319 (use-package custom
 320   :no-require t
 321   :config
 322   (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
 323   (when (file-exists-p custom-file)
 324     (load custom-file))
 325   (setf custom-safe-themes t))
 326 #+end_src
 327
 328 ** Secrets file
 329
 330 #+begin_src emacs-lisp
 331 (load (no-littering-expand-etc-file-name "secrets"))
 332 #+end_src
 333
 334 ** Better =$PATH= handling
 335
 336 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
 337 in my shell.
 338
 339 #+begin_src emacs-lisp
 340 (use-package exec-path-from-shell
 341   :defer 1
 342   :init
 343   (setq exec-path-from-shell-check-startup-files nil)
 344   :config
 345   (exec-path-from-shell-initialize)
 346   ;; while we're at it, let's fix access to our running ssh-agent
 347   (exec-path-from-shell-copy-env "SSH_AGENT_PID")
 348   (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
 349 #+end_src
 350
 351 ** Only one custom theme at a time
 352
 353 #+begin_src emacs-lisp
 354 (defadvice load-theme (before clear-previous-themes activate)
 355   "Clear existing theme settings instead of layering them"
 356   (mapc #'disable-theme custom-enabled-themes))
 357 #+end_src
 358
 359 ** Server
 360
 361 Start server if not already running. Alternatively, can be done by
 362 issuing =emacs --daemon= in the terminal, which can be automated with
 363 a systemd service or using =brew services start emacs= on macOS. I use
 364 Emacs as my window manager (via EXWM), so I always start Emacs on
 365 login; so starting the server from inside Emacs is good enough for me.
 366
 367 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
 368
 369 #+begin_src emacs-lisp
 370 (use-package server
 371   :defer 1
 372   :config (or (server-running-p) (server-mode)))
 373 #+end_src
 374
 375 ** COMMENT Unicode support
 376
 377 Font stack with better unicode support, around =Ubuntu Mono= and
 378 =Hack=.
 379
 380 #+begin_src emacs-lisp :tangle no
 381 (dolist (ft (fontset-list))
 382   (set-fontset-font
 383    ft
 384    'unicode
 385    (font-spec :name "Source Code Pro" :size 14))
 386   (set-fontset-font
 387    ft
 388    'unicode
 389    (font-spec :name "DejaVu Sans Mono")
 390    nil
 391    'append)
 392   ;; (set-fontset-font
 393   ;;  ft
 394   ;;  'unicode
 395   ;;  (font-spec
 396   ;;   :name "Symbola monospacified for DejaVu Sans Mono")
 397   ;;  nil
 398   ;;  'append)
 399   ;; (set-fontset-font
 400   ;;  ft
 401   ;;  #x2115  ; ℕ
 402   ;;  (font-spec :name "DejaVu Sans Mono")
 403   ;;  nil
 404   ;;  'append)
 405   (set-fontset-font
 406    ft
 407    (cons ?Α ?ω)
 408    (font-spec :name "DejaVu Sans Mono" :size 14)
 409    nil
 410    'prepend))
 411 #+end_src
 412
 413 ** Gentler font resizing
 414
 415 #+begin_src emacs-lisp
 416 (setq text-scale-mode-step 1.05)
 417 #+end_src
 418
 419 ** Libraries
 420
 421 #+begin_src emacs-lisp
 422 (require 'cl-lib)
 423 (require 'subr-x)
 424 #+end_src
 425
 426 ** Useful utilities
 427
 428 #+begin_src emacs-lisp
 429 (defun amin-enlist (exp)
 430   "Return EXP wrapped in a list, or as-is if already a list."
 431 (if (listp exp) exp (list exp)))
 432
 433 ; from https://github.com/hlissner/doom-emacs/commit/589108fdb270f24a98ba6209f6955fe41530b3ef
 434 (defmacro after! (features &rest body)
 435   "A smart wrapper around `with-eval-after-load'. Supresses warnings during
 436 compilation."
 437   (declare (indent defun) (debug t))
 438   (list (if (or (not (bound-and-true-p byte-compile-current-file))
 439                 (dolist (next (amin-enlist features))
 440                   (if (symbolp next)
 441                       (require next nil :no-error)
 442                     (load next :no-message :no-error))))
 443             #'progn
 444           #'with-no-warnings)
 445         (cond ((symbolp features)
 446                `(eval-after-load ',features '(progn ,@body)))
 447               ((and (consp features)
 448                     (memq (car features) '(:or :any)))
 449                `(progn
 450                   ,@(cl-loop for next in (cdr features)
 451                              collect `(after! ,next ,@body))))
 452               ((and (consp features)
 453                     (memq (car features) '(:and :all)))
 454                (dolist (next (cdr features))
 455                  (setq body `(after! ,next ,@body)))
 456                body)
 457               ((listp features)
 458                `(after! (:all ,@features) ,@body)))))
 459 #+end_src
 460
 461 Convenience macro for =setq='ing multiple variables to the same value:
 462
 463 #+begin_src emacs-lisp
 464 (defmacro setq-every! (value &rest vars)
 465   "Set all the variables from VARS to value VALUE."
 466   (declare (indent defun) (debug t))
 467   `(progn ,@(mapcar (lambda (x) (list 'setq x value)) vars)))
 468 #+end_src
 469
 470 * Core
 471 :PROPERTIES:
 472 :CUSTOM_ID: core
 473 :END:
 474
 475 ** Defaults
 476
 477 *** Time and battery in mode-line
 478
 479 Enable displaying time and battery in the mode-line, since I'm not
 480 using the Xfce panel anymore. Also, I don't need to see the load
 481 average on a regular basis, so disable that.
 482
 483 Note: using =i3status= on sway at the moment, so disabling this.
 484
 485 #+begin_src emacs-lisp :tangle no
 486 (use-package time
 487   :init
 488   (setq display-time-default-load-average nil)
 489   :config
 490   (display-time-mode))
 491
 492 (use-package battery
 493   :config
 494   (display-battery-mode))
 495 #+end_src
 496
 497 *** Smaller fringe
 498
 499 Might want to set the fringe to a smaller value, especially if using
 500 EXWM. I'm fine with the default for now.
 501
 502 #+begin_src emacs-lisp
 503 ;; (fringe-mode '(3 . 1))
 504 (fringe-mode nil)
 505 #+end_src
 506
 507 *** Disable disabled commands
 508
 509 Emacs disables some commands by default that could persumably be
 510 confusing for novice users. Let's disable that.
 511
 512 #+begin_src emacs-lisp
 513 (setq disabled-command-function nil)
 514 #+end_src
 515
 516 *** Kill-ring
 517
 518 Save what I copy into clipboard from other applications into Emacs'
 519 kill-ring, which would allow me to still be able to easily access it
 520 in case I kill (cut or copy) something else inside Emacs before
 521 yanking (pasting) what I'd originally intended to.
 522
 523 #+begin_src emacs-lisp
 524 (setq save-interprogram-paste-before-kill t)
 525 #+end_src
 526
 527 *** Minibuffer
 528
 529 #+begin_src emacs-lisp
 530 (setq enable-recursive-minibuffers t
 531       resize-mini-windows t)
 532 #+end_src
 533
 534 *** Lazy-person-friendly yes/no prompts
 535
 536 Lazy people would prefer to type fewer keystrokes, especially for yes
 537 or no questions. I'm lazy.
 538
 539 #+begin_src emacs-lisp
 540 (defalias 'yes-or-no-p #'y-or-n-p)
 541 #+end_src
 542
 543 *** Startup screen and =*scratch*=
 544
 545 Firstly, let Emacs know that I'd like to have =*scratch*= as my
 546 startup buffer.
 547
 548 #+begin_src emacs-lisp
 549 (setq initial-buffer-choice t)
 550 #+end_src
 551
 552 Now let's customize the =*scratch*= buffer a bit. First off, I don't
 553 need the default hint.
 554
 555 #+begin_src emacs-lisp
 556 (setq initial-scratch-message nil)
 557 #+end_src
 558
 559 Also, let's use Text mode as the major mode, in case I want to
 560 customize it (=*scratch*='s default major mode, Fundamental mode,
 561 can't really be customized).
 562
 563 #+begin_src emacs-lisp
 564 (setq initial-major-mode 'text-mode)
 565 #+end_src
 566
 567 Inhibit the buffer list when more than 2 files are loaded.
 568
 569 #+begin_src emacs-lisp
 570 (setq inhibit-startup-buffer-menu t)
 571 #+end_src
 572
 573 I don't really need to see the startup screen or echo area message
 574 either.
 575
 576 #+begin_src emacs-lisp
 577 (advice-add #'display-startup-echo-area-message :override #'ignore)
 578 (setq inhibit-startup-screen t
 579       inhibit-startup-echo-area-message user-login-name)
 580 #+end_src
 581
 582 *** More useful frame titles
 583
 584 Show either the file name or the buffer name (in case the buffer isn't
 585 visiting a file). Borrowed from Emacs Prelude.
 586
 587 #+begin_src emacs-lisp
 588 (setq frame-title-format
 589       '("" invocation-name " - "
 590         (:eval (if (buffer-file-name)
 591                    (abbreviate-file-name (buffer-file-name))
 592                  "%b"))))
 593 #+end_src
 594
 595 *** Backups
 596
 597 Emacs' default backup settings aren't that great. Let's use more
 598 sensible options. See documentation for the ~make-backup-file~
 599 variable.
 600
 601 #+begin_src emacs-lisp
 602 (setq backup-by-copying t
 603       version-control t
 604       delete-old-versions t)
 605 #+end_src
 606
 607 *** Auto revert
 608
 609 Enable automatic reloading of changed buffers and files.
 610
 611 #+begin_src emacs-lisp
 612 (global-auto-revert-mode 1)
 613 (setq auto-revert-verbose nil
 614       global-auto-revert-non-file-buffers nil)
 615 #+end_src
 616
 617 *** Always use space for indentation
 618
 619 #+begin_src emacs-lisp
 620 (setq-default
 621  indent-tabs-mode nil
 622  require-final-newline t
 623  tab-width 4)
 624 #+end_src
 625
 626 *** Winner mode
 627
 628 Enable =winner-mode=.
 629
 630 #+begin_src emacs-lisp
 631 (winner-mode 1)
 632 #+end_src
 633
 634 *** Close =*compilation*= on success
 635
 636 #+begin_src emacs-lisp
 637 (setq compilation-exit-message-function
 638       (lambda (status code msg)
 639         "Close the compilation window if successful."
 640         ;; if M-x compile exits with 0
 641          (when (and (eq status 'exit) (zerop code))
 642            (bury-buffer)
 643            (delete-window (get-buffer-window (get-buffer "*compilation*"))))
 644          ;; return the result of compilation-exit-message-function
 645          (cons msg code)))
 646 #+end_src
 647
 648 *** Search for non-ASCII characters
 649
 650 I’d like non-ASCII characters such as ‘’“”«»‹›áⓐ𝒶 to be selected when
 651 I search for their ASCII counterpart.  Shoutout to [[http://endlessparentheses.com/new-in-emacs-25-1-easily-search-non-ascii-characters.html][endlessparentheses]]
 652 for this.
 653
 654 #+begin_src emacs-lisp
 655 (setq search-default-mode #'char-fold-to-regexp)
 656
 657 ;; uncomment to extend this behaviour to query-replace
 658 ;; (setq replace-char-fold t)
 659 #+end_src
 660
 661 ** Bindings
 662
 663 #+begin_src emacs-lisp
 664 (bind-keys
 665  ("s-c e b" . eval-buffer)
 666  ("s-c e r" . eval-region)
 667
 668  ("s-p"     . beginning-of-buffer)
 669  ("s-n"     . end-of-buffer))
 670 #+end_src
 671
 672 ** Packages
 673
 674 The packages in this section are absolutely essential to my everyday
 675 workflow, and they play key roles in how I do my computing. They
 676 immensely enhance the Emacs experience for me; both using Emacs, and
 677 customizing it.
 678
 679 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
 680
 681 #+begin_src emacs-lisp
 682 (use-package auto-compile
 683   :demand t
 684   :config
 685   (auto-compile-on-load-mode)
 686   (auto-compile-on-save-mode)
 687   (setq auto-compile-display-buffer               nil
 688         auto-compile-mode-line-counter            t
 689         auto-compile-source-recreate-deletes-dest t
 690         auto-compile-toggle-deletes-nonlib-dest   t
 691         auto-compile-update-autoloads             t)
 692   (add-hook 'auto-compile-inhibit-compile-hook
 693             'auto-compile-inhibit-compile-detached-git-head))
 694 #+end_src
 695
 696 *** [[https://github.com/noctuid/general.el][general]]
 697
 698 #+begin_src emacs-lisp
 699 (use-package general
 700   :demand t
 701   :config
 702   (general-evil-setup t)
 703   (general-override-mode)
 704
 705   (general-create-definer
 706    amin--leader-keys
 707    :keymaps 'override
 708    :states '(emacs normal visual motion insert)
 709    :non-normal-prefix "M-m"
 710    :prefix "SPC"))
 711 #+end_src
 712
 713 *** [[https://github.com/emacs-evil/evil][evil]]
 714
 715 #+begin_src emacs-lisp
 716 (use-package evil
 717   :demand t
 718   ;; :hook (org-src-mode . evil-motion-state)
 719   :config
 720   (evil-mode 1)
 721   (general-swap-key nil '(normal motion) ";" ":")
 722
 723   (setq evil-want-visual-char-semi-exclusive t)
 724
 725   ;; custom mode state mappings
 726   (dolist (mspair '((ebdb-mode    . emacs)
 727                     (helpful-mode . motion)
 728                     (view-mode    . motion)))
 729     (evil-set-initial-state (car mspair) (cdr mspair)))
 730
 731   ;; fix tab and indentation in src blocks inside org-mode buffer
 732   ;; also see https://git.sr.ht/~bandali/dotfiles/commit/0e2ffd584aafdd4cf256bcdf2473f01c3aaaed55
 733   (unbind-key "TAB" evil-motion-state-map)
 734
 735   (unbind-key "C-d" evil-insert-state-map)
 736   (unbind-key "C-v" evil-insert-state-map)
 737   (unbind-key "C-y" evil-insert-state-map)
 738   (unbind-key "C-a" evil-insert-state-map)
 739   (unbind-key "C-e" evil-insert-state-map)
 740   (unbind-key "C-p" evil-insert-state-map)
 741   (unbind-key "C-n" evil-insert-state-map)
 742   (unbind-key "C-k" evil-insert-state-map)
 743   (bind-keys
 744     :map evil-insert-state-map
 745     ("C-k"   . kill-line)
 746     ("C-S-k" . evil-insert-digraph)
 747     :map evil-motion-state-map
 748     ([down-mouse-1] . nil)))
 749 #+end_src
 750
 751 #+begin_src emacs-lisp
 752 (use-package evil-escape
 753   :after evil
 754   :init
 755   (setq evil-escape-excluded-states '(normal visual multiedit emacs motion)
 756         evil-escape-excluded-major-modes '(neotree-mode)
 757         evil-escape-key-sequence "jk"
 758         evil-escape-delay 0.25)
 759   ;; :general
 760   ;; (:states '(insert replace visual operator)
 761   ;;          "C-g" #'evil-escape)
 762   :config
 763   (evil-escape-mode 1)
 764   ;; no `evil-escape' in minibuffer
 765   (push #'minibufferp evil-escape-inhibit-functions))
 766 #+end_src
 767
 768 #+begin_src emacs-lisp
 769 (use-package evil-nerd-commenter
 770   :after evil
 771   :general
 772   (nmap
 773     "gc" 'evilnc-comment-operator
 774     "gy" 'evilnc-copy-and-comment-lines))
 775 #+end_src
 776
 777 #+begin_src emacs-lisp
 778 (use-package evil-surround
 779   :after evil
 780   :general
 781   (omap
 782     "s" 'evil-surround-edit
 783     "S" 'evil-Surround-edit)
 784   (vmap
 785     "S" 'evil-surround-region
 786     "gS" 'evil-Surround-region))
 787 #+end_src
 788
 789 #+begin_src emacs-lisp
 790 (amin--leader-keys
 791   "/"   '(:ignore t :wk "search")
 792
 793   "b"   '(:ignore t :wk "buffers")
 794   "b k" 'kill-this-buffer
 795   "b s" 'save-buffer
 796
 797   "e"   '(:ignore t :wk "eval")
 798   "e b" 'eval-buffer
 799   "e r" 'eval-region
 800
 801   "e e" 'shell-pop
 802
 803   "f"   '(:ignore t :wk "files")
 804
 805   "F"   '(:ignore t :wk "frames")
 806   "F m" 'make-frame-command
 807   "F d" 'delete-frame
 808   "F D" 'delete-other-frames
 809
 810   "h"   '(:ignore t :wk "help(ful)")
 811   "h c" 'describe-char
 812   "h f" 'describe-function
 813   "h F" 'describe-face
 814   "h H" 'view-hello-file
 815   "h i" 'info
 816   "h k" 'describe-key
 817   "h l" 'view-lossage
 818   "h v" 'describe-variable
 819
 820   "o"   'other-window
 821
 822   "w"   '(:ignore t :wk "window")
 823   "w o" 'other-window
 824   "w 0" 'delete-window
 825   "w 1" 'delete-other-windows
 826   "w 2" 'split-window-below
 827   "w 3" 'split-window-right
 828   "w u" 'winner-undo
 829   "w r" 'winner-redo
 830
 831   "q"   '(:ignore t :wk "quit")
 832   "q q" 'save-buffers-kill-terminal)
 833 #+end_src
 834
 835 *** [[https://orgmode.org/][Org mode]]
 836
 837 #+begin_quote
 838 Org mode is for keeping notes, maintaining TODO lists, planning
 839 projects, and authoring documents with a fast and effective plain-text
 840 system.
 841 #+end_quote
 842
 843 In short, my favourite way of life.
 844
 845 #+begin_src emacs-lisp
 846 (use-package org
 847   :defer 3
 848   :general
 849   (amin--leader-keys
 850     :states 'normal
 851     :keymaps 'org-mode-map
 852     "'" 'org-edit-special)
 853   (amin--leader-keys
 854     :definer 'minor-mode
 855     :states 'normal
 856     :keymaps 'org-src-mode
 857     "'" 'org-edit-src-exit
 858     "k" 'org-edit-src-abort)
 859   (general-define-key
 860    :definer 'minor-mode
 861    :states 'normal
 862    :keymaps 'org-src-mode
 863    "q" 'org-edit-src-exit)
 864   :config
 865   (setq org-src-tab-acts-natively t
 866         org-src-preserve-indentation nil
 867         org-edit-src-content-indentation 0
 868         org-email-link-description-format "Email %c: %s" ; %.30s
 869         org-log-done 'time)
 870   (add-to-list 'org-structure-template-alist '("L" . "src emacs-lisp") t)
 871   (after! org-src
 872     (define-key org-src-mode-map [remap evil-write] 'org-edit-src-save)
 873     (define-key org-src-mode-map [remap evil-save-and-close]
 874       (lambda () (interactive)
 875         (org-edit-src-save)
 876         (org-edit-src-exit)))
 877     (define-key org-src-mode-map [remap evil-save-modified-and-close]
 878       (lambda () (interactive)
 879         (org-edit-src-save)
 880         (org-edit-src-exit)))
 881     (define-key org-src-mode-map [remap evil-quit] 'org-edit-src-abort))
 882   :bind (:map org-mode-map ("M-L" . org-insert-last-stored-link))
 883   :hook ((org-mode . org-indent-mode)
 884          (org-mode . auto-fill-mode)
 885          (org-mode . flyspell-mode))
 886   :custom
 887   (org-latex-packages-alist '(("" "listings") ("" "color"))))
 888
 889 (use-package ox-latex
 890   :after ox
 891   :config
 892   (setq org-latex-listings 'listings
 893         ;; org-latex-prefer-user-labels t
 894         )
 895   (add-to-list 'org-latex-packages-alist '("" "listings"))
 896   (add-to-list 'org-latex-packages-alist '("" "color"))
 897   (add-to-list 'org-latex-classes
 898                '("IEEEtran" "\\documentclass[11pt]{IEEEtran}"
 899                  ("\\section{%s}" . "\\section*{%s}")
 900                  ("\\subsection{%s}" . "\\subsection*{%s}")
 901                  ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
 902                  ("\\paragraph{%s}" . "\\paragraph*{%s}")
 903                  ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
 904                t))
 905
 906 (use-package ox-beamer
 907   :after ox)
 908
 909 (use-package ob-tangle
 910   :general
 911   (amin--leader-keys
 912     :states 'normal
 913     :keymaps 'org-mode-map
 914     "b t" 'org-babel-tangle))
 915
 916 (use-package orgalist
 917   :after message
 918   :hook (message-mode . orgalist-mode))
 919 #+end_src
 920
 921 **** asynchronous tangle
 922
 923 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
 924 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
 925 file.
 926
 927 #+begin_src emacs-lisp
 928 (after! org
 929   (defvar amin-show-async-tangle-results nil
 930     "Keep *emacs* async buffers around for later inspection.")
 931
 932   (defvar amin-show-async-tangle-time nil
 933     "Show the time spent tangling the file.")
 934
 935   (defvar amin-async-tangle-post-compile "make ti"
 936     "If non-nil, pass to `compile' after successful tangle.")
 937
 938   (defun amin/async-babel-tangle ()
 939     "Tangle org file asynchronously."
 940     (interactive)
 941     (let* ((file-tangle-start-time (current-time))
 942            (file (buffer-file-name))
 943            (file-nodir (file-name-nondirectory file))
 944            (async-quiet-switch "-q"))
 945       (async-start
 946        `(lambda ()
 947           (require 'org)
 948           (org-babel-tangle-file ,file))
 949        (unless amin-show-async-tangle-results
 950          `(lambda (result)
 951             (if result
 952                 (progn
 953                   (message "Tangled %s%s"
 954                            ,file-nodir
 955                            (if amin-show-async-tangle-time
 956                                (format " (%.3fs)"
 957                                        (float-time (time-subtract (current-time)
 958                                                                   ',file-tangle-start-time)))
 959                              ""))
 960                   (when amin-async-tangle-post-compile
 961                     (compile amin-async-tangle-post-compile)))
 962               (message "Tangling %s failed" ,file-nodir))))))))
 963
 964 (add-to-list
 965  'safe-local-variable-values
 966  '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
 967 #+end_src
 968
 969 *** [[https://magit.vc/][Magit]]
 970
 971 #+begin_quote
 972 It's Magit! A Git porcelain inside Emacs.
 973 #+end_quote
 974
 975 Not just how I do git, but /the/ way to do git.
 976
 977 #+begin_src emacs-lisp
 978 (use-package magit
 979   :defer 2
 980   :general (amin--leader-keys "g s" 'magit-status)
 981   :bind ("s-g" . magit-status)
 982   :config
 983   (magit-add-section-hook 'magit-status-sections-hook
 984                           'magit-insert-modules
 985                           'magit-insert-stashes
 986                           'append)
 987   (setq
 988    magit-repository-directories '(("~/.emacs.d/" . 0)
 989                                   ("~/src/git/" . 1)))
 990   (nconc magit-section-initial-visibility-alist
 991          '(([unpulled status] . show)
 992            ([unpushed status] . show)))
 993   :custom-face (magit-diff-file-heading ((t (:weight normal)))))
 994 #+end_src
 995
 996 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
 997
 998 #+begin_quote
 999 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
1000 an overview, and more. Oh, man!
1001 #+end_quote
1002
1003 There's no way I could top that, so I won't attempt to.
1004
1005 **** Ivy
1006
1007 #+begin_src emacs-lisp
1008 (use-package ivy
1009   :defer 1
1010   :general (amin--leader-keys "," 'ivy-switch-buffer)
1011   :bind
1012   (:map ivy-minibuffer-map
1013    ([escape] . keyboard-escape-quit)
1014    ([S-up]   . ivy-previous-history-element)
1015    ([S-down] . ivy-next-history-element)
1016    ("DEL"    . ivy-backward-delete-char))
1017   :config
1018   (setq ivy-wrap t)
1019   (ivy-mode 1)
1020   :custom-face
1021   (ivy-minibuffer-match-face-2 ((t (:background "#e99ce8" :weight semi-bold))))
1022   (ivy-minibuffer-match-face-3 ((t (:background "#bbbbff" :weight semi-bold))))
1023   (ivy-minibuffer-match-face-4 ((t (:background "#ffbbff" :weight semi-bold)))))
1024 #+end_src
1025
1026 **** Swiper
1027
1028 #+begin_src emacs-lisp
1029 (use-package swiper
1030   :general (:states '(normal motion) "/" 'swiper)
1031   :bind (("C-s" . swiper)
1032          ("C-r" . swiper)))
1033 #+end_src
1034
1035 **** Counsel
1036
1037 #+begin_src emacs-lisp
1038 (use-package counsel
1039   :defer 1
1040   :general
1041   (amin--leader-keys
1042     "r" 'counsel-recentf
1043     "SPC" 'counsel-M-x
1044     "."   'counsel-find-file)
1045   :bind (([remap execute-extended-command] . counsel-M-x)
1046          ([remap find-file]                . counsel-find-file)
1047          ("s-r"                            . counsel-recentf)
1048          ("C-c x"                          . counsel-M-x)
1049          ("C-c f ."                        . counsel-find-file)
1050          :map minibuffer-local-map
1051          ("C-r" . counsel-minibuffer-history))
1052   :config
1053   (counsel-mode 1)
1054   (defalias 'locate #'counsel-locate))
1055 #+end_src
1056
1057 *** eshell
1058
1059 #+begin_src emacs-lisp
1060 (use-package eshell
1061   :defer t
1062   :commands eshell
1063   :config
1064   (eval-when-compile (defvar eshell-prompt-regexp))
1065   (defun amin/eshell-quit-or-delete-char (arg)
1066     (interactive "p")
1067     (if (and (eolp) (looking-back eshell-prompt-regexp nil))
1068         (eshell-life-is-too-much)
1069       (delete-char arg)))
1070
1071   (defun amin/eshell-clear ()
1072     (interactive)
1073     (let ((inhibit-read-only t))
1074       (erase-buffer))
1075     (eshell-send-input))
1076
1077   (defun amin|eshell-setup ()
1078     (bind-keys :map eshell-mode-map
1079                ("C-d" . amin/eshell-quit-or-delete-char)
1080                ("C-l" . amin/eshell-clear)))
1081
1082   :hook (eshell-mode . amin|eshell-setup))
1083 #+end_src
1084
1085 *** Ibuffer
1086
1087 #+begin_src emacs-lisp
1088 (use-package ibuffer
1089   :defer t
1090   :general (amin--leader-keys "b b" 'ibuffer-other-window)
1091   :bind
1092   (("C-x C-b" . ibuffer-other-window)
1093    :map ibuffer-mode-map
1094    ("P"   . ibuffer-backward-filter-group)
1095    ("N"   . ibuffer-forward-filter-group)
1096    ("M-p" . ibuffer-do-print)
1097    ("M-n" . ibuffer-do-shell-command-pipe-replace))
1098   :config
1099   ;; Use human readable Size column instead of original one
1100   (define-ibuffer-column size-h
1101     (:name "Size" :inline t)
1102     (cond
1103      ((> (buffer-size) 1000000) (format "%7.1fM" (/ (buffer-size) 1000000.0)))
1104      ((> (buffer-size) 100000) (format "%7.0fk" (/ (buffer-size) 1000.0)))
1105      ((> (buffer-size) 1000) (format "%7.1fk" (/ (buffer-size) 1000.0)))
1106      (t (format "%8d" (buffer-size)))))
1107   :custom
1108   (ibuffer-saved-filter-groups
1109    '(("default"
1110       ("dired" (mode . dired-mode))
1111       ("org"   (mode . org-mode))
1112       ("web"
1113        (or
1114         (mode . web-mode)
1115         (mode . css-mode)
1116         (mode . scss-mode)
1117         (mode . js2-mode)))
1118       ("shell"
1119        (or
1120         (mode . eshell-mode)
1121         (mode . shell-mode)))
1122       ("notmuch" (name . "\*notmuch\*"))
1123       ("programming"
1124        (or
1125         (mode . python-mode)
1126         (mode . c++-mode)
1127         (mode . emacs-lisp-mode)))
1128       ("emacs"
1129        (or
1130         (name . "^\\*scratch\\*$")
1131         (name . "^\\*Messages\\*$")))
1132       ("slack"
1133        (or
1134         (name . "^\\*Slack*"))))))
1135   (ibuffer-formats
1136    '((mark modified read-only locked " "
1137            (name 18 18 :left :elide)
1138            " "
1139            (size-h 9 -1 :right)
1140            " "
1141            (mode 16 16 :left :elide)
1142            " " filename-and-process)
1143      (mark " "
1144            (name 16 -1)
1145            " " filename)))
1146   :hook (ibuffer . (lambda () (ibuffer-switch-to-saved-filter-groups "default"))))
1147 #+end_src
1148
1149 *** Outline
1150
1151 #+begin_src emacs-lisp
1152 (use-package outline
1153   :defer t
1154   :hook (prog-mode . outline-minor-mode)
1155   :bind
1156   (:map
1157    outline-minor-mode-map
1158    ("<s-tab>"  . outline-toggle-children)
1159    ("M-p"      . outline-previous-visible-heading)
1160    ("M-n"      . outline-next-visible-heading)
1161    :prefix-map amin--outline-prefix-map
1162    :prefix "s-o"
1163    ("TAB" . outline-toggle-children)
1164    ("a"   . outline-hide-body)
1165    ("H"   . outline-hide-body)
1166    ("S"   . outline-show-all)
1167    ("h"   . outline-hide-subtree)
1168    ("s"   . outline-show-subtree)))
1169 #+end_src
1170
1171 * Borg's =layer/essentials=
1172
1173 TODO: break this giant source block down into individual org sections.
1174
1175 #+begin_src emacs-lisp
1176 (use-package dash
1177   :config (dash-enable-font-lock))
1178
1179 (use-package diff-hl
1180   :config
1181   (setq diff-hl-draw-borders nil)
1182   (global-diff-hl-mode)
1183   (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
1184
1185 (use-package dired
1186   :defer t
1187   :config (setq dired-listing-switches "-alh"))
1188
1189 (use-package eldoc
1190   :when (version< "25" emacs-version)
1191   :config (global-eldoc-mode))
1192
1193 (use-package help
1194   :defer t
1195   :config
1196   (temp-buffer-resize-mode)
1197   (setq help-window-select t))
1198
1199 (progn ;    `isearch'
1200   (setq isearch-allow-scroll t))
1201
1202 (use-package lisp-mode
1203   :config
1204   (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
1205   (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
1206   (defun indent-spaces-mode ()
1207     (setq indent-tabs-mode nil))
1208   (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
1209
1210 (use-package man
1211   :defer t
1212   :config (setq Man-width 80))
1213
1214 (use-package paren
1215   :config (show-paren-mode))
1216
1217 (use-package prog-mode
1218   :config (global-prettify-symbols-mode)
1219   (defun indicate-buffer-boundaries-left ()
1220     (setq indicate-buffer-boundaries 'left))
1221   (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
1222
1223 (use-package recentf
1224   :defer 0.5
1225   :config
1226   (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:")
1227   (setq recentf-max-saved-items 40))
1228
1229 (use-package savehist
1230   :config (savehist-mode))
1231
1232 (use-package saveplace
1233   :when (version< "25" emacs-version)
1234   :config (save-place-mode))
1235
1236 (use-package simple
1237   :config (column-number-mode))
1238
1239 (progn ;    `text-mode'
1240   (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
1241
1242 (use-package tramp
1243   :defer t
1244   :config
1245   (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
1246   (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
1247   (add-to-list 'tramp-default-proxies-alist
1248                (list (regexp-quote (system-name)) nil nil)))
1249
1250 (use-package undo-tree
1251   :config
1252   (global-undo-tree-mode -1))
1253   ;; :bind (("C-?" . undo-tree-undo)
1254   ;;        ("M-_" . undo-tree-redo))
1255   ;; :config
1256   ;; (global-undo-tree-mode)
1257   ;; (setq undo-tree-mode-lighter ""
1258   ;;       undo-tree-auto-save-history t))
1259 #+end_src
1260
1261 * Editing
1262
1263 ** Company
1264
1265 #+begin_src emacs-lisp
1266 (use-package company
1267   :defer 2
1268   :bind
1269   (:map company-active-map
1270         ([tab]    . company-complete-common-or-cycle)
1271         ([escape] . company-abort))
1272   :custom
1273   (company-idle-delay 0.3)
1274   (company-minimum-prefix-length 1)
1275   (company-selection-wrap-around t)
1276   (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
1277   (company-dabbrev-downcase nil)
1278   (company-dabbrev-ignore-case nil)
1279   :config
1280   (global-company-mode t))
1281 #+end_src
1282
1283 * Syntax and spell checking
1284 #+begin_src emacs-lisp
1285 (use-package flycheck
1286   :defer 3
1287   :hook (prog-mode . flycheck-mode)
1288   :bind
1289   (:map flycheck-mode-map
1290         ("M-P" . flycheck-previous-error)
1291         ("M-N" . flycheck-next-error))
1292   :config
1293   ;; Use the load-path from running Emacs when checking elisp files
1294   (setq flycheck-emacs-lisp-load-path 'inherit)
1295
1296   ;; Only flycheck when I actually save the buffer
1297   (setq flycheck-check-syntax-automatically '(mode-enabled save)))
1298
1299 ;; http://endlessparentheses.com/ispell-and-apostrophes.html
1300 (use-package ispell
1301   :defer 3
1302   :config
1303   ;; ’ can be part of a word
1304   (setq ispell-local-dictionary-alist
1305         `((nil "[[:alpha:]]" "[^[:alpha:]]"
1306                "['\x2019]" nil ("-B") nil utf-8)))
1307   ;; don't send ’ to the subprocess
1308   (defun endless/replace-apostrophe (args)
1309     (cons (replace-regexp-in-string
1310            "’" "'" (car args))
1311           (cdr args)))
1312   (advice-add #'ispell-send-string :filter-args
1313               #'endless/replace-apostrophe)
1314
1315   ;; convert ' back to ’ from the subprocess
1316   (defun endless/replace-quote (args)
1317     (if (not (derived-mode-p 'org-mode))
1318         args
1319       (cons (replace-regexp-in-string
1320              "'" "’" (car args))
1321             (cdr args))))
1322   (advice-add #'ispell-parse-output :filter-args
1323               #'endless/replace-quote))
1324 #+end_src
1325 * Programming modes
1326
1327 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
1328
1329 #+begin_src emacs-lisp
1330 (use-package alloy-mode
1331   :defer t
1332   :config (setq alloy-basic-offset 2))
1333 #+end_src
1334
1335 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
1336
1337 #+begin_src emacs-lisp
1338 (use-package proof-site  ; Proof General
1339   :defer t
1340   :load-path "lib/proof-site/generic/")
1341 #+end_src
1342
1343 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
1344
1345 #+begin_src emacs-lisp
1346 (eval-when-compile (defvar lean-mode-map))
1347 (use-package lean-mode
1348   :defer 1
1349   :bind (:map lean-mode-map
1350               ("S-SPC" . company-complete))
1351   :config
1352   (require 'lean-input)
1353   (setq default-input-method "Lean"
1354         lean-input-tweak-all '(lean-input-compose
1355                                (lean-input-prepend "/")
1356                                (lean-input-nonempty))
1357         lean-input-user-translations '(("/" "/")))
1358   (lean-input-setup))
1359   #+end_src
1360
1361 ** Haskell
1362
1363 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
1364
1365 #+begin_src emacs-lisp
1366 (use-package haskell-mode
1367   :defer t
1368   :config
1369   (setq haskell-indentation-layout-offset 4
1370         haskell-indentation-left-offset 4
1371         flycheck-checker 'haskell-hlint
1372         flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
1373 #+end_src
1374
1375 *** [[https://github.com/jyp/dante][dante]]
1376
1377 #+begin_src emacs-lisp
1378 (use-package dante
1379   :after haskell-mode
1380   :commands dante-mode
1381   :hook (haskell-mode . dante-mode))
1382 #+end_src
1383
1384 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1385
1386 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1387 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1388
1389 #+begin_src emacs-lisp
1390 (use-package hlint-refactor
1391   :after haskell-mode
1392   :bind (:map hlint-refactor-mode-map
1393               ("C-c l b" . hlint-refactor-refactor-buffer)
1394               ("C-c l r" . hlint-refactor-refactor-at-point))
1395   :hook (haskell-mode . hlint-refactor-mode))
1396 #+end_src
1397
1398 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1399
1400 #+begin_src emacs-lisp
1401 (use-package flycheck-haskell
1402   :after haskell-mode)
1403 #+end_src
1404
1405 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1406 :PROPERTIES:
1407 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1408 :END:
1409
1410 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1411 instead.
1412
1413 #+begin_src emacs-lisp :tangle no
1414 ;;; hs-lint.el --- minor mode for HLint code checking
1415
1416 ;; Copyright 2009 (C) Alex Ott
1417 ;;
1418 ;; Author: Alex Ott <alexott@gmail.com>
1419 ;; Keywords: haskell, lint, HLint
1420 ;; Requirements:
1421 ;; Status: distributed under terms of GPL2 or above
1422
1423 ;; Typical message from HLint looks like:
1424 ;;
1425 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1426 ;; Found:
1427 ;;   count1 p l = length (filter p l)
1428 ;; Why not:
1429 ;;   count1 p = length . filter p
1430
1431
1432 (require 'compile)
1433
1434 (defgroup hs-lint nil
1435   "Run HLint as inferior of Emacs, parse error messages."
1436   :group 'tools
1437   :group 'haskell)
1438
1439 (defcustom hs-lint-command "hlint"
1440   "The default hs-lint command for \\[hlint]."
1441   :type 'string
1442   :group 'hs-lint)
1443
1444 (defcustom hs-lint-save-files t
1445   "Save modified files when run HLint or no (ask user)"
1446   :type 'boolean
1447   :group 'hs-lint)
1448
1449 (defcustom hs-lint-replace-with-suggestions nil
1450   "Replace user's code with suggested replacements"
1451   :type 'boolean
1452   :group 'hs-lint)
1453
1454 (defcustom hs-lint-replace-without-ask nil
1455   "Replace user's code with suggested replacements automatically"
1456   :type 'boolean
1457   :group 'hs-lint)
1458
1459 (defun hs-lint-process-setup ()
1460   "Setup compilation variables and buffer for `hlint'."
1461   (run-hooks 'hs-lint-setup-hook))
1462
1463 ;; regex for replace suggestions
1464 ;;
1465 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1466 ;; Found:
1467 ;; \s +\(.*\)
1468 ;; Why not:
1469 ;; \s +\(.*\)
1470
1471 (defvar hs-lint-regex
1472   "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1473   "Regex for HLint messages")
1474
1475 (defun make-short-string (str maxlen)
1476   (if (< (length str) maxlen)
1477       str
1478     (concat (substring str 0 (- maxlen 3)) "...")))
1479
1480 (defun hs-lint-replace-suggestions ()
1481   "Perform actual replacement of suggestions"
1482   (goto-char (point-min))
1483   (while (re-search-forward hs-lint-regex nil t)
1484     (let* ((fname (match-string 1))
1485           (fline (string-to-number (match-string 2)))
1486           (old-code (match-string 4))
1487           (new-code (match-string 5))
1488           (msg (concat "Replace '" (make-short-string old-code 30)
1489                        "' with '" (make-short-string new-code 30) "'"))
1490           (bline 0)
1491           (eline 0)
1492           (spos 0)
1493           (new-old-code ""))
1494       (save-excursion
1495         (switch-to-buffer (get-file-buffer fname))
1496         (goto-char (point-min))
1497         (forward-line (1- fline))
1498         (beginning-of-line)
1499         (setf bline (point))
1500         (when (or hs-lint-replace-without-ask
1501                   (yes-or-no-p msg))
1502           (end-of-line)
1503           (setf eline (point))
1504           (beginning-of-line)
1505           (setf old-code (regexp-quote old-code))
1506           (while (string-match "\\\\ " old-code spos)
1507             (setf new-old-code (concat new-old-code
1508                                  (substring old-code spos (match-beginning 0))
1509                                  "\\ *"))
1510             (setf spos (match-end 0)))
1511           (setf new-old-code (concat new-old-code (substring old-code spos)))
1512           (remove-text-properties bline eline '(composition nil))
1513           (when (re-search-forward new-old-code eline t)
1514             (replace-match new-code nil t)))))))
1515
1516 (defun hs-lint-finish-hook (buf msg)
1517   "Function, that is executed at the end of HLint execution"
1518   (if hs-lint-replace-with-suggestions
1519       (hs-lint-replace-suggestions)
1520       (next-error 1 t)))
1521
1522 (define-compilation-mode hs-lint-mode "HLint"
1523   "Mode for check Haskell source code."
1524   (set (make-local-variable 'compilation-process-setup-function)
1525        'hs-lint-process-setup)
1526   (set (make-local-variable 'compilation-disable-input) t)
1527   (set (make-local-variable 'compilation-scroll-output) nil)
1528   (set (make-local-variable 'compilation-finish-functions)
1529        (list 'hs-lint-finish-hook))
1530   )
1531
1532 (defun hs-lint ()
1533   "Run HLint for current buffer with haskell source"
1534   (interactive)
1535   (save-some-buffers hs-lint-save-files)
1536   (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1537                      'hs-lint-mode))
1538
1539 (provide 'hs-lint)
1540 ;;; hs-lint.el ends here
1541 #+end_src
1542
1543 #+begin_src emacs-lisp :tangle no
1544 (use-package hs-lint
1545   :load-path "lisp/"
1546   :bind (:map haskell-mode-map
1547               ("C-c l l" . hs-lint)))
1548 #+end_src
1549
1550 ** Web dev
1551
1552 *** SGML and HTML
1553
1554 #+begin_src emacs-lisp
1555 (use-package sgml-mode
1556   :defer t
1557   :config
1558   (setq sgml-basic-offset 2))
1559 #+end_src
1560
1561 *** CSS and SCSS
1562
1563 #+begin_src emacs-lisp
1564 (use-package css-mode
1565   :defer t
1566   :config
1567   (setq css-indent-offset 2))
1568 #+end_src
1569
1570 *** Web mode
1571
1572 #+begin_src emacs-lisp
1573 (use-package web-mode
1574   :defer t
1575   :mode "\\.html\\'"
1576   :config
1577   (setq-every! 2
1578     web-mode-code-indent-offset
1579     web-mode-css-indent-offset
1580     web-mode-markup-indent-offset))
1581 #+end_src
1582
1583 *** Emmet mode
1584
1585 #+begin_src emacs-lisp
1586 (use-package emmet-mode
1587   :after (:any web-mode css-mode sgml-mode)
1588   :bind* (("C-)" . emmet-next-edit-point)
1589           ("C-(" . emmet-prev-edit-point))
1590   :config
1591   (unbind-key "C-j" emmet-mode-keymap)
1592   (setq emmet-move-cursor-between-quotes t)
1593   :hook (web-mode css-mode html-mode sgml-mode))
1594 #+end_src
1595
1596 ** Nix
1597
1598 #+begin_src emacs-lisp
1599 (use-package nix-mode
1600   :defer t
1601   :mode "\\.nix\\'")
1602 #+end_src
1603
1604 ** Java
1605
1606 *** meghanada
1607
1608 #+begin_src emacs-lisp :tangle no
1609 (use-package meghanada
1610   :bind
1611   (:map meghanada-mode-map
1612         (("C-M-o" . meghanada-optimize-import)
1613          ("C-M-t" . meghanada-import-all)))
1614   :hook (java-mode . meghanada-mode))
1615 #+end_src
1616
1617 *** lsp-java
1618
1619 #+begin_comment
1620 dependencies:
1621
1622 ace-window
1623 avy
1624 bui
1625 company-lsp
1626 dap-mode
1627 lsp-java
1628 lsp-mode
1629 lsp-ui
1630 pfuture
1631 tree-mode
1632 treemacs
1633 #+end_comment
1634
1635 #+begin_src emacs-lisp :tangle no
1636 (use-package treemacs
1637   :config (setq treemacs-never-persist t))
1638
1639 (use-package yasnippet
1640   :config
1641   ;; (yas-global-mode)
1642   )
1643
1644 (use-package lsp-mode
1645   :init (setq lsp-eldoc-render-all nil
1646               lsp-highlight-symbol-at-point nil)
1647   )
1648
1649 (use-package hydra)
1650
1651 (use-package company-lsp
1652   :after  company
1653   :config
1654   (setq company-lsp-cache-candidates t
1655         company-lsp-async t))
1656
1657 (use-package lsp-ui
1658   :config
1659   (setq lsp-ui-sideline-update-mode 'point))
1660
1661 (use-package lsp-java
1662   :config
1663   (add-hook 'java-mode-hook
1664             (lambda ()
1665               (setq-local company-backends (list 'company-lsp))))
1666
1667   (add-hook 'java-mode-hook 'lsp-java-enable)
1668   (add-hook 'java-mode-hook 'flycheck-mode)
1669   (add-hook 'java-mode-hook 'company-mode)
1670   (add-hook 'java-mode-hook 'lsp-ui-mode))
1671
1672 (use-package dap-mode
1673   :after lsp-mode
1674   :config
1675   (dap-mode t)
1676   (dap-ui-mode t))
1677
1678 (use-package dap-java
1679   :after (lsp-java))
1680
1681 (use-package lsp-java-treemacs
1682   :after (treemacs))
1683 #+end_src
1684
1685 * Emacs Enhancements
1686
1687 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1688
1689 #+begin_quote
1690 Emacs package that displays available keybindings in popup
1691 #+end_quote
1692
1693 #+begin_src emacs-lisp
1694 (use-package which-key
1695   :defer 1
1696   :config (which-key-mode))
1697 #+end_src
1698
1699 ** [[https://github.com/Malabarba/smart-mode-line][smart-mode-line]]
1700
1701 #+begin_src emacs-lisp
1702 (use-package smart-mode-line
1703   :config
1704   (sml/setup)
1705   ;; (sml/apply-theme 'light)
1706   (remove-hook 'display-time-hook 'sml/propertize-time-string))
1707 #+end_src
1708
1709 ** [[https://github.com/bbatsov/crux][crux]]
1710
1711 #+begin_src emacs-lisp
1712 (use-package crux
1713   :defer 1
1714   :general
1715   (amin--leader-keys
1716     "b K" 'crux-kill-other-buffers
1717     "c d" 'crux-duplicate-current-line-or-region
1718     "c D" 'crux-duplicate-and-comment-current-line-or-region
1719     "f c" 'crux-copy-file-preserve-attributes
1720     "f d" 'crux-delete-file-and-buffer
1721     "f r" 'crux-rename-file-and-buffer)
1722   :bind (("C-c d" . crux-duplicate-current-line-or-region)
1723          ("C-c D" . crux-duplicate-and-comment-current-line-or-region)
1724          ("C-S-j" . crux-top-join-line)
1725          ("C-c j" . crux-top-join-line)))
1726 #+end_src
1727
1728 ** [[https://github.com/alezost/mwim.el][mwim]]
1729
1730 #+begin_src emacs-lisp
1731 (use-package mwim
1732   :general
1733   (:states '(normal visual)
1734            "0" 'mwim-beginning-of-code-or-line
1735            "$" 'mwim-end-of-code-or-line)
1736   :bind (("C-a"    . mwim-beginning-of-code-or-line)
1737          ("C-e"    . mwim-end-of-code-or-line)
1738          ("<home>" . mwim-beginning-of-line-or-code)
1739          ("<end>"  . mwim-end-of-line-or-code)))
1740 #+end_src
1741
1742 ** projectile
1743
1744 #+begin_src emacs-lisp
1745 (use-package projectile
1746   :defer 2
1747   :bind-keymap ("C-c p" . projectile-command-map)
1748   :config
1749   (projectile-mode)
1750
1751   (defun my-projectile-invalidate-cache (&rest _args)
1752     ;; ignore the args to `magit-checkout'
1753     (projectile-invalidate-cache nil))
1754
1755   (eval-after-load 'magit-branch
1756     '(progn
1757        (advice-add 'magit-checkout
1758                    :after #'my-projectile-invalidate-cache)
1759        (advice-add 'magit-branch-and-checkout
1760                    :after #'my-projectile-invalidate-cache))))
1761 #+end_src
1762
1763 ** [[https://github.com/Wilfred/helpful][helpful]]
1764
1765 #+begin_src emacs-lisp
1766 (use-package helpful
1767   :defer 1
1768   :general
1769   (amin--leader-keys
1770     "h h"   '(:ignore t :wk "helpful")
1771     "h h c" 'helpful-command
1772     "h h f" 'helpful-callable           ; helpful-function
1773     "h h v" 'helpful-variable
1774     "h h k" 'helpful-key
1775     "h h p" 'helpful-at-point))
1776 #+end_src
1777
1778 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1779
1780 #+begin_src emacs-lisp
1781 (use-package shell-pop
1782   :defer 1
1783   :init
1784   (setq shell-pop-universal-key "C-c e"
1785         shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1786 #+end_src
1787
1788 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1789
1790 Make =*scratch*= and =*Messages*= unkillable.
1791
1792 #+begin_src emacs-lisp
1793 (use-package unkillable-scratch
1794   :defer 3
1795   :config
1796   (unkillable-scratch 1)
1797   :custom
1798   (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1799 #+end_src
1800
1801 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1802
1803 #+begin_example
1804 ,----
1805 | make pretty boxed quotes like this
1806 `----
1807 #+end_example
1808
1809 #+begin_src emacs-lisp
1810 (use-package boxquote
1811   :defer 3
1812   :bind
1813   (:prefix-map amin--boxquote-prefix-map
1814    :prefix "C-c q"
1815    ("b"   . boxquote-buffer)
1816    ("B"   . boxquote-insert-buffer)
1817    ("d"   . boxquote-defun)
1818    ("F"   . boxquote-insert-file)
1819    ("hf"  . boxquote-describe-function)
1820    ("hk"  . boxquote-describe-key)
1821    ("hv"  . boxquote-describe-variable)
1822    ("hw"  . boxquote-where-is)
1823    ("k"   . boxquote-kill)
1824    ("p"   . boxquote-paragraph)
1825    ("q"   . boxquote-boxquote)
1826    ("r"   . boxquote-region)
1827    ("s"   . boxquote-shell-command)
1828    ("t"   . boxquote-text)
1829    ("T"   . boxquote-title)
1830    ("u"   . boxquote-unbox)
1831    ("U"   . boxquote-unbox-region)
1832    ("y"   . boxquote-yank)
1833    ("M-q" . boxquote-fill-paragraph)
1834    ("M-w" . boxquote-kill-ring-save)))
1835 #+end_src
1836
1837 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1838
1839 ** COMMENT [[https://github.com/DarthFennec/highlight-indent-guides][highlight-indent-guides]]                                 :ARCHIVE:
1840
1841 #+begin_src emacs-lisp
1842 (use-package highlight-indent-guides
1843   :defer 3
1844   :hook ((prog-mode . highlight-indent-guides-mode)
1845          ;; (org-mode  . highlight-indent-guides-mode)
1846          )
1847   :config
1848   (setq highlight-indent-guides-character ?\|)
1849   (setq highlight-indent-guides-auto-enabled nil)
1850   (setq highlight-indent-guides-method 'character)
1851   (setq highlight-indent-guides-responsive 'top)
1852   (set-face-foreground 'highlight-indent-guides-character-face "gainsboro")
1853   (set-face-foreground 'highlight-indent-guides-top-character-face "grey40")) ; grey13 is nice too
1854 #+end_src
1855
1856 ** pdf-tools
1857
1858 #+begin_src emacs-lisp
1859 (use-package pdf-tools
1860   :defer t
1861   :magic ("%PDF" . pdf-view-mode)
1862   :config
1863   (setq pdf-view-resize-factor 1.05)
1864   (pdf-tools-install)
1865   :bind
1866   (:map pdf-view-mode-map
1867         ("C-s" . isearch-forward)
1868         ("C-r" . isearch-backward)
1869         ("j"   . pdf-view-next-line-or-next-page)
1870         ("k"   . pdf-view-previous-line-or-previous-page)
1871         ("h"   . image-backward-hscroll)
1872         ("l"   . image-forward-hscroll)))
1873 #+end_src
1874
1875 ** anzu
1876
1877 #+begin_src emacs-lisp
1878 (use-package anzu)
1879 #+end_src
1880
1881 ** typo.el
1882
1883 #+begin_src emacs-lisp
1884 (use-package typo
1885   :defer 2
1886   :config
1887   (typo-global-mode 1)
1888   :hook (text-mode . typo-mode))
1889 #+end_src
1890
1891 ** slack
1892
1893 Hopefully temporary.
1894
1895 #+begin_src emacs-lisp
1896 (use-package slack
1897   :commands (slack-start)
1898   :init
1899   (eval-when-compile                    ; silence the byte-compiler
1900     (defvar url-http-data nil)
1901     (defvar url-http-extra-headers nil)
1902     (defvar url-http-method nil)
1903     (defvar url-callback-function nil)
1904     (defvar url-callback-arguments nil)
1905     (defvar oauth--token-data nil))
1906   (setq slack-buffer-emojify t
1907         slack-prefer-current-team t)
1908   :config
1909   (slack-register-team
1910    :name "uw-apv"
1911    :default t
1912    :client-id uw-apv-client-id
1913    :client-secret uw-apv-client-secret
1914    :token uw-apv-token
1915    :subscribed-channels '(general)
1916    :full-and-display-names t)
1917   (slack-register-team
1918    :name "watform"
1919    :default nil
1920    :client-id watform-client-id
1921    :client-secret watform-client-secret
1922    :token watform-token
1923    :subscribed-channels '(general)
1924    :full-and-display-names t)
1925   (add-to-list 'swiper-font-lock-exclude 'slack-message-buffer-mode t)
1926   (setq lui-time-stamp-format "[%Y-%m-%d %H:%M:%S]"
1927         lui-time-stamp-only-when-changed-p t
1928         lui-time-stamp-position 'right)
1929   :bind
1930   (("C-c s s" . slack-start)
1931    ("C-c s u" . slack-select-unread-rooms)
1932    ("C-c s b" . slack-select-rooms)
1933    ("C-c s t" . slack-change-current-team)
1934    ("C-c s c" . slack-ws-close)
1935    :map slack-mode-map
1936    ("M-p"     . slack-buffer-goto-prev-message)
1937    ("M-n"     . slack-buffer-goto-next-message)
1938    ("C-c e"   . slack-message-edit)
1939    ("C-c k"   . slack-message-delete)
1940    ("C-c C-k" . slack-channel-leave)
1941    ("C-c r a" . slack-message-add-reaction)
1942    ("C-c r r" . slack-message-remove-reaction)
1943    ("C-c r s" . slack-message-show-reaction-users)
1944    ("C-c p l" . slack-room-pins-list)
1945    ("C-c p a" . slack-message-pins-add)
1946    ("C-c p r" . slack-message-pins-remove)
1947    ("@"       . slack-message-embed-mention)
1948    ("#"       . slack-message-embed-channel)))
1949
1950 (use-package alert
1951   :commands (alert)
1952   :init
1953   (setq alert-default-style 'notifier))
1954 #+end_src
1955
1956 ** hl-todo
1957
1958 #+begin_src emacs-lisp
1959 (use-package hl-todo
1960   :defer 4
1961   :config
1962   (global-hl-todo-mode))
1963 #+end_src
1964
1965 ** shrink-path
1966
1967 #+begin_src emacs-lisp
1968 (use-package shrink-path
1969   :after eshell
1970   :config
1971   (setq eshell-prompt-regexp "\\(.*\n\\)*λ "
1972         eshell-prompt-function #'+eshell/prompt)
1973
1974   (defun +eshell/prompt ()
1975     (let ((base/dir (shrink-path-prompt default-directory)))
1976       (concat (propertize (car base/dir)
1977                           'face 'font-lock-comment-face)
1978               (propertize (cdr base/dir)
1979                           'face 'font-lock-constant-face)
1980               (propertize (+eshell--current-git-branch)
1981                           'face 'font-lock-function-name-face)
1982               "\n"
1983               (propertize "λ" 'face 'eshell-prompt-face)
1984               ;; needed for the input text to not have prompt face
1985               (propertize " " 'face 'default))))
1986
1987   (defun +eshell--current-git-branch ()
1988     (let ((branch (car (loop for match in (split-string (shell-command-to-string "git branch") "\n")
1989                              when (string-match "^\*" match)
1990                              collect match))))
1991       (if (not (eq branch nil))
1992           (concat " " (substring branch 2))
1993         ""))))
1994 #+end_src
1995
1996 ** magithub
1997
1998 For when I /have to/ use GH.
1999
2000 #+begin_src emacs-lisp
2001 (use-package magithub
2002   :after magit
2003   :config
2004   (magithub-feature-autoinject t)
2005   (setq magithub-clone-default-directory "~/src/git"))
2006 #+end_src
2007
2008 ** [[https://github.com/peterwvj/eshell-up][eshell-up]]
2009
2010 #+begin_src emacs-lisp
2011 (use-package eshell-up
2012   :after eshell)
2013 #+end_src
2014
2015 * Email
2016
2017 #+begin_src emacs-lisp
2018 (defvar amin-maildir (expand-file-name "~/mail/"))
2019 (after! recentf
2020   (add-to-list 'recentf-exclude amin-maildir))
2021 #+end_src
2022
2023 ** Gnus
2024
2025 #+begin_src emacs-lisp
2026 (setq
2027  amin-gnus-init-file (no-littering-expand-etc-file-name "gnus")
2028  mail-user-agent     'gnus-user-agent
2029  read-mail-command   'gnus)
2030
2031 (use-package gnus
2032   :general
2033   (amin--leader-keys
2034     "m" 'gnus
2035     "M" 'gnus-unplugged)
2036   :bind (("s-m" . gnus)
2037          ("s-M" . gnus-unplugged))
2038   :init
2039   (setq
2040    gnus-select-method '(nnnil "")
2041    gnus-secondary-select-methods
2042    '((nnimap "amin"
2043             (nnimap-stream plain)
2044             (nnimap-address "127.0.0.1")
2045             (nnimap-server-port 143)
2046             (nnimap-authenticator plain)
2047             (nnimap-user "amin@aminb.org"))
2048      (nnimap "uwaterloo"
2049              (nnimap-stream plain)
2050              (nnimap-address "127.0.0.1")
2051              (nnimap-server-port 143)
2052              (nnimap-authenticator plain)
2053              (nnimap-user "abandali@uwaterloo.ca")))
2054    gnus-message-archive-group "nnimap:Sent"
2055    gnus-parameters
2056    '(("gnu.*"
2057       (gcc-self . t)))
2058    gnus-large-newsgroup  50
2059    gnus-home-directory   (no-littering-expand-var-file-name "gnus/")
2060    gnus-directory        (concat gnus-home-directory "news/")
2061    message-directory     (concat gnus-home-directory "mail/")
2062    nndraft-directory     (concat gnus-home-directory "drafts/")
2063    gnus-save-newsrc-file nil
2064    gnus-read-newsrc-file nil
2065    gnus-interactive-exit nil
2066    gnus-gcc-mark-as-read t))
2067
2068 (use-package gnus-art
2069   :config
2070   (setq
2071    gnus-visible-headers
2072    (concat gnus-visible-headers "\\|^List-Id:\\|^X-RT-Originator:\\|^User-Agent:")
2073    gnus-sorted-header-list
2074    '("^From:" "^Subject:" "^Summary:" "^Keywords:"
2075      "^Followup-To:" "^To:" "^Cc:" "X-RT-Originator"
2076      "^Newsgroups:" "List-Id:" "^Organization:"
2077      "^User-Agent:" "^Date:")
2078   ;; local-lapsed article dates
2079   ;; from https://www.emacswiki.org/emacs/GnusFormatting#toc11
2080   gnus-article-date-headers '(user-defined)
2081   gnus-article-time-format
2082   (lambda (time)
2083     (let* ((date (format-time-string "%a, %d %b %Y %T %z" time))
2084            (local (article-make-date-line date 'local))
2085            (combined-lapsed (article-make-date-line date
2086                                                     'combined-lapsed))
2087            (lapsed (progn
2088                      (string-match " (.+" combined-lapsed)
2089                      (match-string 0 combined-lapsed))))
2090       (concat local lapsed))))
2091   (bind-keys
2092    :map gnus-article-mode-map
2093    ("r"   . gnus-article-reply-with-original)
2094    ("R"   . gnus-article-wide-reply-with-original)
2095    ("M-L" . org-store-link)))
2096
2097 (use-package gnus-sum
2098   :bind (:map gnus-summary-mode-map
2099               :prefix-map amin--gnus-summary-prefix-map
2100               :prefix "v"
2101               ("r" . gnus-summary-reply)
2102               ("w" . gnus-summary-wide-reply)
2103               ("v" . gnus-summary-show-raw-article))
2104   :config
2105   (bind-keys
2106    :map gnus-summary-mode-map
2107    ("r"   . gnus-summary-reply-with-original)
2108    ("R"   . gnus-summary-wide-reply-with-original)
2109    ("M-L" . org-store-link)))
2110
2111 (use-package gnus-msg
2112   :config
2113   (setq gnus-posting-styles
2114         '((".*"
2115            (address "amin@aminb.org")
2116            (body "\nBest,\namin\n"))
2117           ("gnu.*"
2118            (address "bandali@gnu.org"))
2119           ((header "subject" "ThankCRM")
2120            (to "webmasters-comment@gnu.org"))
2121           ("nnimap\\+uwaterloo:.*"
2122            (address "abandali@uwaterloo.ca")
2123            (gcc "\"nnimap+uwaterloo:Sent Items\"")))))
2124
2125 (use-package gnus-topic
2126   :hook (gnus-group-mode . gnus-topic-mode))
2127
2128 (use-package gnus-agent
2129   :config
2130   (setq gnus-agent-synchronize-flags 'ask)
2131   :hook (gnus-group-mode . gnus-agent-mode))
2132
2133 (use-package gnus-group
2134   :config
2135   (setq gnus-permanently-visible-groups "\\((INBOX\\|gnu$\\)"))
2136
2137 (use-package mm-decode
2138   :config
2139   (setq mm-discouraged-alternatives '("text/html" "text/richtext")))
2140 #+end_src
2141
2142 ** sendmail
2143
2144 #+begin_src emacs-lisp
2145 (use-package sendmail
2146   :config
2147   (setq sendmail-program "/usr/bin/msmtp"
2148         ;; message-sendmail-extra-arguments '("-v" "-d")
2149         mail-specify-envelope-from t
2150         mail-envelope-from 'header))
2151 #+end_src
2152
2153 ** message
2154
2155 #+begin_src emacs-lisp
2156 (use-package message
2157   :config
2158   (defconst message-cite-style-bandali
2159     '((message-cite-function  'message-cite-original)
2160       (message-citation-line-function  'message-insert-formatted-citation-line)
2161       (message-cite-reply-position 'traditional)
2162       (message-yank-prefix  "> ")
2163       (message-yank-cited-prefix  ">")
2164       (message-yank-empty-prefix  ">")
2165       (message-citation-line-format "Hi %F,\n\nOn %Y-%m-%d %l:%M %p, %N wrote:"))
2166     "Citation style based on Mozilla Thunderbird's. Use with message-cite-style.")
2167   (setq message-cite-style 'message-cite-style-bandali
2168         message-kill-buffer-on-exit t
2169         message-send-mail-function 'message-send-mail-with-sendmail
2170         message-sendmail-envelope-from 'header
2171         message-dont-reply-to-names
2172         "\\(\\(.*@aminb\\.org\\)\\|\\(\\(aminb?\\|mab\\|bandali\\)@gnu\\.org\\)\\|\\(\\(m\\|a\\(min\\.\\)?\\)bandali@uwaterloo\\.ca\\)\\)"
2173         message-user-fqdn "aminb.org")
2174   :hook (;; (message-setup . mml-secure-message-sign-pgpmime)
2175          (message-mode . flyspell-mode)
2176          (message-mode . (lambda () (setq fill-column 65
2177                                      message-fill-column 65))))
2178   :custom-face
2179   (message-header-subject ((t (:foreground "#111" :weight semi-bold))))
2180   (message-header-to      ((t (:foreground "#111" :weight normal))))
2181   (message-header-cc      ((t (:foreground "#333" :weight normal)))))
2182
2183 (after! mml-sec
2184   (setq mml-secure-openpgp-encrypt-to-self t
2185         mml-secure-openpgp-sign-with-sender t))
2186 #+end_src
2187
2188 ** footnote
2189
2190 Convenient footnotes in =message-mode=.
2191
2192 #+begin_src emacs-lisp
2193 (use-package footnote
2194   :after message
2195   :bind
2196   (:map message-mode-map
2197         :prefix-map amin--footnote-prefix-map
2198         :prefix "C-c f"
2199         ("a" . footnote-add-footnote)
2200         ("b" . footnote-back-to-message)
2201         ("c" . footnote-cycle-style)
2202         ("d" . footnote-delete-footnote)
2203         ("g" . footnote-goto-footnote)
2204         ("r" . footnote-renumber-footnotes)
2205         ("s" . footnote-set-style))
2206   :config
2207   (setq footnote-start-tag ""
2208         footnote-end-tag   ""
2209         footnote-style     'unicode))
2210 #+end_src
2211
2212 ** COMMENT supercite
2213
2214 #+begin_src emacs-lisp
2215 (use-package supercite
2216   :after message
2217   :init
2218   (setq sc-nested-citation-p t
2219         ;; sc-cite-blank-lines-p t
2220         sc-citation-leader ""
2221         sc-reference-tag-string ""
2222         sc-preferred-header-style 5     ; (sc-header-author-writes)
2223         sc-auto-fill-region-p nil
2224         sc-confirm-always-p nil)
2225   :config
2226   ;;   (defun amin--sc-header-on-wrote ()
2227   ;;     "\"On <date>, <sc-author> wrote:\" unless:
2228   ;; 1. the \"sc-author\" field cannot be found, in which case nothing is inserted;
2229   ;; 2. the \"date\" field is missing in which case only the from part is printed."
2230   ;;     (let ((sc-mumble "")
2231   ;;          (whofrom (sc-whofrom)))
2232   ;;       (if whofrom
2233   ;;          (insert sc-reference-tag-string
2234   ;;                      (sc-hdr "On " (sc-mail-field "date") ", ")
2235   ;;                      (sc-hdr "" (sc-mail-field "sc-author")) " wrote:\n"))))
2236   ;;   (defun amin--sc-header ()
2237   ;;     "Hi <firstname>,\n\n <from> writes:"
2238   ;;     (let ((sc-mumble "")
2239   ;;          (whofrom (sc-whofrom)))
2240   ;;       (if whofrom
2241   ;;          (insert (sc-hdr "Hi " (sc-mail-field "sc-firstname") ",\n\n")
2242   ;;                   sc-reference-tag-string
2243   ;;                      whofrom
2244   ;;                      " writes:\n"))))
2245   ;; (add-to-list 'sc-rewrite-header-list '(amin--sc-header) t)
2246   ;; (add-to-list 'sc-rewrite-header-list '(amin--sc-header-on-wrote) t)
2247   ;; (setq sc-preferred-header-style (1- (length sc-rewrite-header-list)))
2248   (add-hook 'mail-citation-hook 'sc-cite-original))
2249 #+end_src
2250
2251 ** ebdb
2252
2253 #+begin_src emacs-lisp
2254 (use-package ebdb
2255   :defer 1
2256   :bind (:map gnus-group-mode-map ("e" . ebdb))
2257   :config
2258   (setq ebdb-sources (no-littering-expand-var-file-name "ebdb")))
2259
2260 (use-package ebdb-com
2261   :after ebdb)
2262
2263 (use-package ebdb-complete
2264   :after ebdb
2265   :config
2266   (ebdb-complete-enable))
2267
2268 (use-package ebdb-gnus
2269   :after ebdb)
2270
2271 (use-package ebdb-message
2272   :after ebdb)
2273
2274 ;; (use-package ebdb-vcard
2275 ;;   :after ebdb)
2276 #+end_src
2277
2278 ** COMMENT bbdb
2279
2280 #+begin_comment
2281 [submodule "bbdb"]
2282         path = lib/bbdb
2283         url = https://git.savannah.nongnu.org/git/bbdb.git
2284         load-path = lisp/elisp
2285         info-path = doc
2286         build-step = ./autogen.sh
2287         build-step = ./configure --with-lispdir=elisp
2288         build-step = make
2289         build-step = make install
2290 #+end_comment
2291
2292 #+begin_src emacs-lisp
2293 (use-package bbdb
2294   :init
2295   (bbdb-mua-auto-update-init 'message)
2296   (setq bbdb-mua-auto-update-p 'query)
2297   (add-hook 'gnus-startup-hook 'bbdb-insinuate-gnus))
2298 #+end_src
2299
2300 ** COMMENT message-x
2301
2302 #+begin_src emacs-lisp
2303 (use-package message-x
2304   :custom
2305   (message-x-completion-alist
2306    (quote
2307     (("\\([rR]esent-\\|[rR]eply-\\)?[tT]o:\\|[bB]?[cC][cC]:" . gnus-harvest-find-address)
2308      ((if
2309           (boundp
2310            (quote message-newgroups-header-regexp))
2311           message-newgroups-header-regexp message-newsgroups-header-regexp)
2312       . message-expand-group)))))
2313 #+end_src
2314
2315 ** COMMENT gnus-harvest
2316
2317 #+begin_src emacs-lisp
2318 (use-package gnus-harvest
2319   :commands gnus-harvest-install
2320   :demand t
2321   :config
2322   (if (featurep 'message-x)
2323       (gnus-harvest-install 'message-x)
2324     (gnus-harvest-install)))
2325 #+end_src
2326
2327 ** COMMENT gnus-alias                                              :ARCHIVE:
2328
2329 #+begin_src emacs-lisp
2330 (use-package gnus-alias
2331   :commands (gnus-alias-determine-identity
2332              gnus-alias-select-identity)
2333   :bind (:map  message-mode-map
2334                ("s-i" . gnus-alias-select-identity))
2335   :config
2336   (setq
2337    gnus-alias-default-identity "amin"
2338    gnus-alias-identity-alist
2339    '(("amin"
2340       nil   ;; Does not refer to any other identity
2341       "Amin Bandali <amin@aminb.org>"
2342       nil   ;; Organization
2343       nil   ;; extra headers
2344       nil   ;; extra body text
2345       nil)  ;; signature file
2346      ("gnu"
2347       nil
2348       "Amin Bandali <bandali@gnu.org>"
2349       nil
2350       nil
2351       nil
2352       nil)
2353      ("uw"
2354       nil
2355       "Amin Bandali <abandali@uwaterloo.ca>"
2356       nil
2357       (("Gcc" . "\"nnimap+uwaterloo:Sent Items\""))
2358       nil
2359       nil))
2360    gnus-alias-identity-rules
2361    '(("amin" ("Delivered-To" "<amin\\@aminb\\.org" both) "amin")
2362      ("gnu" ("Delivered-To" "<gnu\\@aminb\\.org" both) "gnu")
2363      ("uw" ("any" "<\\(.+\\)\\@uwaterloo\\.ca" both) "uw"))
2364    gnus-alias-override-user-mail-address t)
2365   :hook (message-setup . gnus-alias-determine-identity))
2366 #+end_src
2367
2368 ** COMMENT [[https://notmuchmail.org][notmuch]]                                                 :ARCHIVE:
2369
2370 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
2371
2372 #+begin_src emacs-lisp
2373 (defun amin/notmuch ()
2374   "Delete other windows, then launch `notmuch'."
2375   (interactive
2376    (when (equal current-prefix-arg nil)
2377      (delete-other-windows)))
2378   (notmuch))
2379
2380 (use-package notmuch
2381   :commands notmuch
2382   :bind ("C-c n" . amin/notmuch)
2383   :custom (notmuch-always-prompt-for-sender t)
2384   :config
2385   (setq notmuch-hello-sections
2386         '(notmuch-hello-insert-header
2387           notmuch-hello-insert-saved-searches
2388           ;; notmuch-hello-insert-search
2389           notmuch-hello-insert-alltags)
2390         notmuch-search-oldest-first nil
2391         notmuch-show-all-tags-list t
2392         notmuch-message-headers  ; see bug follow-up above
2393         '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
2394         notmuch-hello-thousands-separator ","
2395         notmuch-fcc-dirs
2396         '(("amin@aminb.org"        . "amin/Sent")
2397           ("bandali@gnu.org"       . "gnu/Sent")
2398           ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
2399           ("mab@gnu.org"           . "gnu/Sent")
2400           ("amin@gnu.org"          . "gnu/Sent")
2401           ("aminb@gnu.org"         . "gnu/Sent")
2402           (".*"                    . "sent"))
2403         notmuch-search-result-format
2404         '(("date"    . "%12s ")
2405           ("count"   . "%-7s ")
2406           ("authors" . "%-40s ")
2407           ("subject" . "%s ")
2408           ("tags"    . "(%s)"))
2409         notmuch-saved-searches
2410         '((:name "inbox"     :query "tag:inbox"     :key "i")
2411           (:name "unread"    :query "tag:unread"    :key "u")
2412           (:name "latest"    :query "tag:latest"    :key "l")
2413           (:name "encrypted" :query "tag:encrypted" :key "e")
2414           (:name "flagged"   :query "tag:flagged"   :key "f")
2415           (:name "sent"      :query "tag:sent"      :key "s")
2416           (:name "drafts"    :query "tag:draft"     :key "d")
2417           (:name "all mail"  :query "*"             :key "a")))
2418   ;; (add-hook 'visual-fill-column-mode-hook
2419   ;;           (lambda ()
2420   ;;             (when (string= major-mode 'notmuch-message-mode)
2421   ;;               (setq visual-fill-column-width 70))))
2422   ;; (set! :evil-state 'notmuch-message-mode 'insert)
2423   ;; (advice-add #'notmuch-bury-or-kill-this-buffer
2424   ;;             :override #'kill-this-buffer)
2425   :hook (notmuch-message-mode . doom-modeline-set-special-modeline)
2426   :bind
2427   (:map notmuch-hello-mode-map
2428         ("u" . (lambda ()
2429                  "Search for `unread'-tagged messages"
2430                  (interactive)
2431                  (notmuch-hello-search "tag:unread")))
2432         ("i" . (lambda ()
2433                  "Search for `inbox'-tagged messages"
2434                  (interactive)
2435                  (notmuch-hello-search "tag:inbox")))
2436         ("l" . (lambda ()
2437                  "Search for `latest'-tagged messages"
2438                  (interactive)
2439                  (notmuch-hello-search "tag:latest")))
2440         ("e" . (lambda ()
2441                  "Search for `encrypted'-tagged messages"
2442                  (interactive)
2443                  (notmuch-hello-search "tag:encrypted"))))
2444   (:map notmuch-search-mode-map
2445         ("k" . (lambda ()
2446                  "Mark message read"
2447                  (interactive)
2448                  (notmuch-search-tag '("-unread"))
2449                  ;; (notmuch-search-archive-thread)
2450                  (notmuch-search-next-thread)))
2451         ("u" . (lambda ()
2452                  "Mark message unread"
2453                  (interactive)
2454                  (notmuch-search-tag '("+unread"))
2455                  (notmuch-search-next-thread)))
2456         ("K" . (lambda ()
2457                  "Mark message deleted"
2458                  (interactive)
2459                  (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
2460                  (notmuch-search-next-thread)))
2461         ("S" . (lambda ()
2462                  "Mark message as spam"
2463                  (interactive)
2464                  (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
2465                  (notmuch-search-next-thread))))
2466   (:map notmuch-tree-mode-map
2467         ("k" . (lambda ()
2468                  "Mark message read"
2469                  (interactive)
2470                  (notmuch-tree-tag '("-unread"))
2471                  ;; (notmuch-tree-archive-thread)
2472                  (notmuch-tree-next-message)))
2473         ("u" . (lambda ()
2474                  "Mark message unread"
2475                  (interactive)
2476                  (notmuch-tree-tag '("+unread"))
2477                  (notmuch-tree-next-message)))
2478         ("K" . (lambda ()
2479                  "Mark message deleted"
2480                  (interactive)
2481                  (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
2482                  (notmuch-tree-next-message)))
2483         ("S" . (lambda ()
2484                  "Mark message as spam"
2485                  (interactive)
2486                  (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
2487                  (notmuch-tree-next-message))))
2488   :custom-face
2489   (notmuch-search-unread-face ((t (:weight semi-bold))))
2490   (notmuch-tag-face ((t (:foreground "navy blue" :weight semi-bold)))))
2491
2492 (use-package counsel-notmuch
2493   :bind ("C-c s m" . counsel-notmuch))
2494
2495 (after! notmuch-crypto
2496   (setq notmuch-crypto-process-mime t))
2497
2498 (use-package org-notmuch
2499   :after (:any org notmuch))
2500 #+end_src
2501
2502 * Blogging
2503 ** [[https://ox-hugo.scripter.co][ox-hugo]]
2504
2505 #+begin_src emacs-lisp
2506 (use-package ox-hugo
2507   :after ox)
2508
2509 (use-package ox-hugo-auto-export
2510   :load-path "lib/ox-hugo")
2511 #+end_src
2512
2513 * Post initialization
2514 :PROPERTIES:
2515 :CUSTOM_ID: post-initialization
2516 :END:
2517
2518 Display how long it took to load the init file.
2519
2520 #+begin_src emacs-lisp
2521 (message "Loading %s...done (%.3fs)" user-init-file
2522          (float-time (time-subtract (current-time)
2523                                     amin--before-user-init-time)))
2524 #+end_src
2525
2526 * Footer
2527 :PROPERTIES:
2528 :CUSTOM_ID: footer
2529 :END:
2530
2531 #+begin_src emacs-lisp :comments none
2532 ;;; init.el ends here
2533 #+end_src
2534
2535 * COMMENT Local Variables                                           :ARCHIVE:
2536 # Local Variables:
2537 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)
2538 # End: