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   :init
 720   (setq evil-want-integration nil)
 721   :config
 722   (evil-mode 1)
 723   (general-swap-key nil '(normal motion) ";" ":")
 724
 725   (setq
 726    evil-want-visual-char-semi-exclusive t
 727    evil-move-beyond-eol  t
 728    ;; evil-move-cursor-back nil
 729    )
 730
 731   ;; motion state modes
 732   (dolist (mode '(ebdb-mode
 733                   helpful-mode
 734                   view-mode))
 735     (evil-set-initial-state mode 'motion))
 736
 737   ;; fix tab and indentation in src blocks inside org-mode buffer
 738   ;; also see https://git.sr.ht/~bandali/dotfiles/commit/0e2ffd584aafdd4cf256bcdf2473f01c3aaaed55
 739   (unbind-key "TAB" evil-motion-state-map)
 740
 741   (unbind-key "C-d" evil-insert-state-map)
 742   (unbind-key "C-v" evil-insert-state-map)
 743   (unbind-key "C-y" evil-insert-state-map)
 744   (unbind-key "C-a" evil-insert-state-map)
 745   (unbind-key "C-e" evil-insert-state-map)
 746   (unbind-key "C-p" evil-insert-state-map)
 747   (unbind-key "C-n" evil-insert-state-map)
 748   (unbind-key "C-k" evil-insert-state-map)
 749   (bind-keys
 750     :map evil-insert-state-map
 751     ("C-k"   . kill-line)
 752     ("C-S-k" . evil-insert-digraph)
 753     :map evil-motion-state-map
 754     ([down-mouse-1] . nil)))
 755 #+end_src
 756
 757 #+begin_src emacs-lisp
 758 (use-package evil-escape
 759   :after evil
 760   :init
 761   (setq evil-escape-excluded-states '(normal visual multiedit emacs motion)
 762         evil-escape-excluded-major-modes '(neotree-mode)
 763         evil-escape-key-sequence "jk"
 764         evil-escape-delay 0.25)
 765   ;; :general
 766   ;; (:states '(insert replace visual operator)
 767   ;;          "C-g" #'evil-escape)
 768   :config
 769   (evil-escape-mode 1)
 770   ;; no `evil-escape' in minibuffer
 771   (push #'minibufferp evil-escape-inhibit-functions))
 772 #+end_src
 773
 774 #+begin_src emacs-lisp
 775 (use-package evil-nerd-commenter
 776   :after evil
 777   :general
 778   (nmap
 779     "gc" 'evilnc-comment-operator
 780     "gy" 'evilnc-copy-and-comment-lines))
 781 #+end_src
 782
 783 #+begin_src emacs-lisp
 784 (use-package evil-surround
 785   :after evil
 786   :general
 787   (omap
 788     "s" 'evil-surround-edit
 789     "S" 'evil-Surround-edit)
 790   (vmap
 791     "S" 'evil-surround-region
 792     "gS" 'evil-Surround-region))
 793 #+end_src
 794
 795 #+begin_src emacs-lisp
 796 (amin--leader-keys
 797   "/"   '(:ignore t :wk "search")
 798
 799   "b"   '(:ignore t :wk "buffers")
 800   "b k" 'kill-this-buffer
 801   "b s" 'save-buffer
 802
 803   "e"   '(:ignore t :wk "eval")
 804   "e b" 'eval-buffer
 805   "e r" 'eval-region
 806
 807   "e e" 'shell-pop
 808
 809   "f"   '(:ignore t :wk "files")
 810
 811   "F"   '(:ignore t :wk "frames")
 812   "F m" 'make-frame-command
 813   "F d" 'delete-frame
 814   "F D" 'delete-other-frames
 815
 816   "h"   '(:ignore t :wk "help(ful)")
 817   "h c" 'describe-char
 818   "h f" 'describe-function
 819   "h F" 'describe-face
 820   "h H" 'view-hello-file
 821   "h i" 'info
 822   "h k" 'describe-key
 823   "h l" 'view-lossage
 824   "h v" 'describe-variable
 825
 826   "o"   'other-window
 827
 828   "w"   '(:ignore t :wk "window")
 829   "w o" 'other-window
 830   "w 0" 'delete-window
 831   "w 1" 'delete-other-windows
 832   "w 2" 'split-window-below
 833   "w 3" 'split-window-right
 834   "w u" 'winner-undo
 835   "w r" 'winner-redo
 836
 837   "q"   '(:ignore t :wk "quit")
 838   "q q" 'save-buffers-kill-terminal)
 839 #+end_src
 840
 841 *** [[https://orgmode.org/][Org mode]]
 842
 843 #+begin_quote
 844 Org mode is for keeping notes, maintaining TODO lists, planning
 845 projects, and authoring documents with a fast and effective plain-text
 846 system.
 847 #+end_quote
 848
 849 In short, my favourite way of life.
 850
 851 #+begin_src emacs-lisp
 852 (use-package org
 853   :defer 3
 854   :general
 855   (amin--leader-keys
 856     :states 'normal
 857     :keymaps 'org-mode-map
 858     "'" 'org-edit-special)
 859   (amin--leader-keys
 860     :definer 'minor-mode
 861     :states 'normal
 862     :keymaps 'org-src-mode
 863     "'" 'org-edit-src-exit
 864     "k" 'org-edit-src-abort)
 865   (general-define-key
 866    :definer 'minor-mode
 867    :states 'normal
 868    :keymaps 'org-src-mode
 869    "q" 'org-edit-src-exit)
 870   :config
 871   (setq org-src-tab-acts-natively t
 872         org-src-preserve-indentation nil
 873         org-edit-src-content-indentation 0
 874         org-email-link-description-format "Email %c: %s" ; %.30s
 875         org-log-done 'time)
 876   (add-to-list 'org-structure-template-alist '("L" . "src emacs-lisp") t)
 877   (after! org-src
 878     (define-key org-src-mode-map [remap evil-write] 'org-edit-src-save)
 879     (define-key org-src-mode-map [remap evil-save-and-close]
 880       (lambda () (interactive)
 881         (org-edit-src-save)
 882         (org-edit-src-exit)))
 883     (define-key org-src-mode-map [remap evil-save-modified-and-close]
 884       (lambda () (interactive)
 885         (org-edit-src-save)
 886         (org-edit-src-exit)))
 887     (define-key org-src-mode-map [remap evil-quit] 'org-edit-src-abort))
 888   :bind (:map org-mode-map ("M-L" . org-insert-last-stored-link))
 889   :hook ((org-mode . org-indent-mode)
 890          (org-mode . auto-fill-mode)
 891          (org-mode . flyspell-mode))
 892   :custom
 893   (org-latex-packages-alist '(("" "listings") ("" "color"))))
 894
 895 (use-package ox-latex
 896   :after ox
 897   :config
 898   (setq org-latex-listings 'listings
 899         ;; org-latex-prefer-user-labels t
 900         )
 901   (add-to-list 'org-latex-packages-alist '("" "listings"))
 902   (add-to-list 'org-latex-packages-alist '("" "color"))
 903   (add-to-list 'org-latex-classes
 904                '("IEEEtran" "\\documentclass[11pt]{IEEEtran}"
 905                  ("\\section{%s}" . "\\section*{%s}")
 906                  ("\\subsection{%s}" . "\\subsection*{%s}")
 907                  ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
 908                  ("\\paragraph{%s}" . "\\paragraph*{%s}")
 909                  ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
 910                t))
 911
 912 (use-package ox-beamer
 913   :after ox)
 914
 915 (use-package ob-tangle
 916   :general
 917   (amin--leader-keys
 918     :states 'normal
 919     :keymaps 'org-mode-map
 920     "b t" 'org-babel-tangle))
 921
 922 (use-package orgalist
 923   :after message
 924   :hook (message-mode . orgalist-mode))
 925 #+end_src
 926
 927 **** asynchronous tangle
 928
 929 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
 930 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
 931 file.
 932
 933 #+begin_src emacs-lisp
 934 (after! org
 935   (defvar amin-show-async-tangle-results nil
 936     "Keep *emacs* async buffers around for later inspection.")
 937
 938   (defvar amin-show-async-tangle-time nil
 939     "Show the time spent tangling the file.")
 940
 941   (defvar amin-async-tangle-post-compile "make ti"
 942     "If non-nil, pass to `compile' after successful tangle.")
 943
 944   (defun amin/async-babel-tangle ()
 945     "Tangle org file asynchronously."
 946     (interactive)
 947     (let* ((file-tangle-start-time (current-time))
 948            (file (buffer-file-name))
 949            (file-nodir (file-name-nondirectory file))
 950            (async-quiet-switch "-q"))
 951       (async-start
 952        `(lambda ()
 953           (require 'org)
 954           (org-babel-tangle-file ,file))
 955        (unless amin-show-async-tangle-results
 956          `(lambda (result)
 957             (if result
 958                 (progn
 959                   (message "Tangled %s%s"
 960                            ,file-nodir
 961                            (if amin-show-async-tangle-time
 962                                (format " (%.3fs)"
 963                                        (float-time (time-subtract (current-time)
 964                                                                   ',file-tangle-start-time)))
 965                              ""))
 966                   (when amin-async-tangle-post-compile
 967                     (compile amin-async-tangle-post-compile)))
 968               (message "Tangling %s failed" ,file-nodir))))))))
 969
 970 (add-to-list
 971  'safe-local-variable-values
 972  '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
 973 #+end_src
 974
 975 *** [[https://magit.vc/][Magit]]
 976
 977 #+begin_quote
 978 It's Magit! A Git porcelain inside Emacs.
 979 #+end_quote
 980
 981 Not just how I do git, but /the/ way to do git.
 982
 983 #+begin_src emacs-lisp
 984 (use-package magit
 985   :defer 2
 986   :general (amin--leader-keys "g s" 'magit-status)
 987   :bind ("s-g" . magit-status)
 988   :config
 989   (magit-add-section-hook 'magit-status-sections-hook
 990                           'magit-insert-modules
 991                           'magit-insert-stashes
 992                           'append)
 993   (setq
 994    magit-repository-directories '(("~/.emacs.d/" . 0)
 995                                   ("~/src/git/" . 1)))
 996   (nconc magit-section-initial-visibility-alist
 997          '(([unpulled status] . show)
 998            ([unpushed status] . show)))
 999   :custom-face (magit-diff-file-heading ((t (:weight normal)))))
1000 #+end_src
1001
1002 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
1003
1004 #+begin_quote
1005 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
1006 an overview, and more. Oh, man!
1007 #+end_quote
1008
1009 There's no way I could top that, so I won't attempt to.
1010
1011 **** Ivy
1012
1013 #+begin_src emacs-lisp
1014 (use-package ivy
1015   :defer 1
1016   :general (amin--leader-keys "," 'ivy-switch-buffer)
1017   :bind
1018   (:map ivy-minibuffer-map
1019    ([escape] . keyboard-escape-quit)
1020    ([S-up]   . ivy-previous-history-element)
1021    ([S-down] . ivy-next-history-element)
1022    ("DEL"    . ivy-backward-delete-char))
1023   :config
1024   (setq ivy-wrap t)
1025   (ivy-mode 1)
1026   :custom-face
1027   (ivy-minibuffer-match-face-2 ((t (:background "#e99ce8" :weight semi-bold))))
1028   (ivy-minibuffer-match-face-3 ((t (:background "#bbbbff" :weight semi-bold))))
1029   (ivy-minibuffer-match-face-4 ((t (:background "#ffbbff" :weight semi-bold)))))
1030 #+end_src
1031
1032 **** Swiper
1033
1034 #+begin_src emacs-lisp
1035 (use-package swiper
1036   :general (:states '(normal motion) "/" 'swiper)
1037   :bind (("C-s" . swiper)
1038          ("C-r" . swiper)))
1039 #+end_src
1040
1041 **** Counsel
1042
1043 #+begin_src emacs-lisp
1044 (use-package counsel
1045   :defer 1
1046   :general
1047   (amin--leader-keys
1048     "r" 'counsel-recentf
1049     "SPC" 'counsel-M-x
1050     "."   'counsel-find-file)
1051   :bind (([remap execute-extended-command] . counsel-M-x)
1052          ([remap find-file]                . counsel-find-file)
1053          ("s-r"                            . counsel-recentf)
1054          ("C-c x"                          . counsel-M-x)
1055          ("C-c f ."                        . counsel-find-file)
1056          :map minibuffer-local-map
1057          ("C-r" . counsel-minibuffer-history))
1058   :config
1059   (counsel-mode 1)
1060   (defalias 'locate #'counsel-locate))
1061 #+end_src
1062
1063 *** eshell
1064
1065 #+begin_src emacs-lisp
1066 (use-package eshell
1067   :defer t
1068   :commands eshell
1069   :config
1070   (eval-when-compile (defvar eshell-prompt-regexp))
1071   (defun amin/eshell-quit-or-delete-char (arg)
1072     (interactive "p")
1073     (if (and (eolp) (looking-back eshell-prompt-regexp nil))
1074         (eshell-life-is-too-much)
1075       (delete-char arg)))
1076
1077   (defun amin/eshell-clear ()
1078     (interactive)
1079     (let ((inhibit-read-only t))
1080       (erase-buffer))
1081     (eshell-send-input))
1082
1083   (defun amin|eshell-setup ()
1084     (bind-keys :map eshell-mode-map
1085                ("C-d" . amin/eshell-quit-or-delete-char)
1086                ("C-l" . amin/eshell-clear)))
1087
1088   :hook (eshell-mode . amin|eshell-setup))
1089 #+end_src
1090
1091 *** Ibuffer
1092
1093 #+begin_src emacs-lisp
1094 (use-package ibuffer
1095   :defer t
1096   :general (amin--leader-keys "b b" 'ibuffer-other-window)
1097   :bind
1098   (("C-x C-b" . ibuffer-other-window)
1099    :map ibuffer-mode-map
1100    ("P"   . ibuffer-backward-filter-group)
1101    ("N"   . ibuffer-forward-filter-group)
1102    ("M-p" . ibuffer-do-print)
1103    ("M-n" . ibuffer-do-shell-command-pipe-replace))
1104   :config
1105   ;; Use human readable Size column instead of original one
1106   (define-ibuffer-column size-h
1107     (:name "Size" :inline t)
1108     (cond
1109      ((> (buffer-size) 1000000) (format "%7.1fM" (/ (buffer-size) 1000000.0)))
1110      ((> (buffer-size) 100000) (format "%7.0fk" (/ (buffer-size) 1000.0)))
1111      ((> (buffer-size) 1000) (format "%7.1fk" (/ (buffer-size) 1000.0)))
1112      (t (format "%8d" (buffer-size)))))
1113   :custom
1114   (ibuffer-saved-filter-groups
1115    '(("default"
1116       ("dired" (mode . dired-mode))
1117       ("org"   (mode . org-mode))
1118       ("web"
1119        (or
1120         (mode . web-mode)
1121         (mode . css-mode)
1122         (mode . scss-mode)
1123         (mode . js2-mode)))
1124       ("shell"
1125        (or
1126         (mode . eshell-mode)
1127         (mode . shell-mode)))
1128       ("notmuch" (name . "\*notmuch\*"))
1129       ("programming"
1130        (or
1131         (mode . python-mode)
1132         (mode . c++-mode)
1133         (mode . emacs-lisp-mode)))
1134       ("emacs"
1135        (or
1136         (name . "^\\*scratch\\*$")
1137         (name . "^\\*Messages\\*$")))
1138       ("slack"
1139        (or
1140         (name . "^\\*Slack*"))))))
1141   (ibuffer-formats
1142    '((mark modified read-only locked " "
1143            (name 18 18 :left :elide)
1144            " "
1145            (size-h 9 -1 :right)
1146            " "
1147            (mode 16 16 :left :elide)
1148            " " filename-and-process)
1149      (mark " "
1150            (name 16 -1)
1151            " " filename)))
1152   :hook (ibuffer . (lambda () (ibuffer-switch-to-saved-filter-groups "default"))))
1153 #+end_src
1154
1155 *** Outline
1156
1157 #+begin_src emacs-lisp
1158 (use-package outline
1159   :defer t
1160   :hook (prog-mode . outline-minor-mode)
1161   :bind
1162   (:map
1163    outline-minor-mode-map
1164    ("<s-tab>"  . outline-toggle-children)
1165    ("M-p"      . outline-previous-visible-heading)
1166    ("M-n"      . outline-next-visible-heading)
1167    :prefix-map amin--outline-prefix-map
1168    :prefix "s-o"
1169    ("TAB" . outline-toggle-children)
1170    ("a"   . outline-hide-body)
1171    ("H"   . outline-hide-body)
1172    ("S"   . outline-show-all)
1173    ("h"   . outline-hide-subtree)
1174    ("s"   . outline-show-subtree)))
1175 #+end_src
1176
1177 * Borg's =layer/essentials=
1178
1179 TODO: break this giant source block down into individual org sections.
1180
1181 #+begin_src emacs-lisp
1182 (use-package dash
1183   :config (dash-enable-font-lock))
1184
1185 (use-package diff-hl
1186   :config
1187   (setq diff-hl-draw-borders nil)
1188   (global-diff-hl-mode)
1189   (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
1190
1191 (use-package dired
1192   :defer t
1193   :config (setq dired-listing-switches "-alh"))
1194
1195 (use-package eldoc
1196   :when (version< "25" emacs-version)
1197   :config (global-eldoc-mode))
1198
1199 (use-package help
1200   :defer t
1201   :config
1202   (temp-buffer-resize-mode)
1203   (setq help-window-select t))
1204
1205 (progn ;    `isearch'
1206   (setq isearch-allow-scroll t))
1207
1208 (use-package lisp-mode
1209   :config
1210   (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
1211   (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
1212   (defun indent-spaces-mode ()
1213     (setq indent-tabs-mode nil))
1214   (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
1215
1216 (use-package man
1217   :defer t
1218   :config (setq Man-width 80))
1219
1220 (use-package paren
1221   :config (show-paren-mode))
1222
1223 (use-package prog-mode
1224   :config (global-prettify-symbols-mode)
1225   (defun indicate-buffer-boundaries-left ()
1226     (setq indicate-buffer-boundaries 'left))
1227   (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
1228
1229 (use-package recentf
1230   :defer 0.5
1231   :config
1232   (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:")
1233   (setq recentf-max-saved-items 40))
1234
1235 (use-package savehist
1236   :config (savehist-mode))
1237
1238 (use-package saveplace
1239   :when (version< "25" emacs-version)
1240   :config (save-place-mode))
1241
1242 (use-package simple
1243   :config (column-number-mode))
1244
1245 (progn ;    `text-mode'
1246   (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
1247
1248 (use-package tramp
1249   :defer t
1250   :config
1251   (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
1252   (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
1253   (add-to-list 'tramp-default-proxies-alist
1254                (list (regexp-quote (system-name)) nil nil)))
1255
1256 (use-package undo-tree
1257   :bind (("C-?" . undo-tree-undo)
1258          ("M-_" . undo-tree-redo))
1259   :config
1260   (global-undo-tree-mode)
1261   (setq undo-tree-mode-lighter ""
1262         undo-tree-auto-save-history t))
1263 #+end_src
1264
1265 * Editing
1266
1267 ** Company
1268
1269 #+begin_src emacs-lisp
1270 (use-package company
1271   :defer 2
1272   :bind
1273   (:map company-active-map
1274         ([tab]    . company-complete-common-or-cycle)
1275         ([escape] . company-abort))
1276   :custom
1277   (company-idle-delay 0.3)
1278   (company-minimum-prefix-length 1)
1279   (company-selection-wrap-around t)
1280   (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
1281   (company-dabbrev-downcase nil)
1282   (company-dabbrev-ignore-case nil)
1283   :config
1284   (global-company-mode t))
1285 #+end_src
1286
1287 * Syntax and spell checking
1288 #+begin_src emacs-lisp
1289 (use-package flycheck
1290   :defer 3
1291   :hook (prog-mode . flycheck-mode)
1292   :bind
1293   (:map flycheck-mode-map
1294         ("M-P" . flycheck-previous-error)
1295         ("M-N" . flycheck-next-error))
1296   :config
1297   ;; Use the load-path from running Emacs when checking elisp files
1298   (setq flycheck-emacs-lisp-load-path 'inherit)
1299
1300   ;; Only flycheck when I actually save the buffer
1301   (setq flycheck-check-syntax-automatically '(mode-enabled save)))
1302
1303 ;; http://endlessparentheses.com/ispell-and-apostrophes.html
1304 (use-package ispell
1305   :defer 3
1306   :config
1307   ;; ’ can be part of a word
1308   (setq ispell-local-dictionary-alist
1309         `((nil "[[:alpha:]]" "[^[:alpha:]]"
1310                "['\x2019]" nil ("-B") nil utf-8)))
1311   ;; don't send ’ to the subprocess
1312   (defun endless/replace-apostrophe (args)
1313     (cons (replace-regexp-in-string
1314            "’" "'" (car args))
1315           (cdr args)))
1316   (advice-add #'ispell-send-string :filter-args
1317               #'endless/replace-apostrophe)
1318
1319   ;; convert ' back to ’ from the subprocess
1320   (defun endless/replace-quote (args)
1321     (if (not (derived-mode-p 'org-mode))
1322         args
1323       (cons (replace-regexp-in-string
1324              "'" "’" (car args))
1325             (cdr args))))
1326   (advice-add #'ispell-parse-output :filter-args
1327               #'endless/replace-quote))
1328 #+end_src
1329 * Programming modes
1330
1331 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
1332
1333 #+begin_src emacs-lisp
1334 (use-package alloy-mode
1335   :defer t
1336   :config (setq alloy-basic-offset 2))
1337 #+end_src
1338
1339 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
1340
1341 #+begin_src emacs-lisp
1342 (use-package proof-site  ; Proof General
1343   :defer t
1344   :load-path "lib/proof-site/generic/")
1345 #+end_src
1346
1347 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
1348
1349 #+begin_src emacs-lisp
1350 (eval-when-compile (defvar lean-mode-map))
1351 (use-package lean-mode
1352   :defer 1
1353   :bind (:map lean-mode-map
1354               ("S-SPC" . company-complete))
1355   :config
1356   (require 'lean-input)
1357   (setq default-input-method "Lean"
1358         lean-input-tweak-all '(lean-input-compose
1359                                (lean-input-prepend "/")
1360                                (lean-input-nonempty))
1361         lean-input-user-translations '(("/" "/")))
1362   (lean-input-setup))
1363   #+end_src
1364
1365 ** Haskell
1366
1367 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
1368
1369 #+begin_src emacs-lisp
1370 (use-package haskell-mode
1371   :defer t
1372   :config
1373   (setq haskell-indentation-layout-offset 4
1374         haskell-indentation-left-offset 4
1375         flycheck-checker 'haskell-hlint
1376         flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
1377 #+end_src
1378
1379 *** [[https://github.com/jyp/dante][dante]]
1380
1381 #+begin_src emacs-lisp
1382 (use-package dante
1383   :after haskell-mode
1384   :commands dante-mode
1385   :hook (haskell-mode . dante-mode))
1386 #+end_src
1387
1388 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1389
1390 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1391 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1392
1393 #+begin_src emacs-lisp
1394 (use-package hlint-refactor
1395   :after haskell-mode
1396   :bind (:map hlint-refactor-mode-map
1397               ("C-c l b" . hlint-refactor-refactor-buffer)
1398               ("C-c l r" . hlint-refactor-refactor-at-point))
1399   :hook (haskell-mode . hlint-refactor-mode))
1400 #+end_src
1401
1402 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1403
1404 #+begin_src emacs-lisp
1405 (use-package flycheck-haskell
1406   :after haskell-mode)
1407 #+end_src
1408
1409 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1410 :PROPERTIES:
1411 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1412 :END:
1413
1414 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1415 instead.
1416
1417 #+begin_src emacs-lisp :tangle no
1418 ;;; hs-lint.el --- minor mode for HLint code checking
1419
1420 ;; Copyright 2009 (C) Alex Ott
1421 ;;
1422 ;; Author: Alex Ott <alexott@gmail.com>
1423 ;; Keywords: haskell, lint, HLint
1424 ;; Requirements:
1425 ;; Status: distributed under terms of GPL2 or above
1426
1427 ;; Typical message from HLint looks like:
1428 ;;
1429 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1430 ;; Found:
1431 ;;   count1 p l = length (filter p l)
1432 ;; Why not:
1433 ;;   count1 p = length . filter p
1434
1435
1436 (require 'compile)
1437
1438 (defgroup hs-lint nil
1439   "Run HLint as inferior of Emacs, parse error messages."
1440   :group 'tools
1441   :group 'haskell)
1442
1443 (defcustom hs-lint-command "hlint"
1444   "The default hs-lint command for \\[hlint]."
1445   :type 'string
1446   :group 'hs-lint)
1447
1448 (defcustom hs-lint-save-files t
1449   "Save modified files when run HLint or no (ask user)"
1450   :type 'boolean
1451   :group 'hs-lint)
1452
1453 (defcustom hs-lint-replace-with-suggestions nil
1454   "Replace user's code with suggested replacements"
1455   :type 'boolean
1456   :group 'hs-lint)
1457
1458 (defcustom hs-lint-replace-without-ask nil
1459   "Replace user's code with suggested replacements automatically"
1460   :type 'boolean
1461   :group 'hs-lint)
1462
1463 (defun hs-lint-process-setup ()
1464   "Setup compilation variables and buffer for `hlint'."
1465   (run-hooks 'hs-lint-setup-hook))
1466
1467 ;; regex for replace suggestions
1468 ;;
1469 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1470 ;; Found:
1471 ;; \s +\(.*\)
1472 ;; Why not:
1473 ;; \s +\(.*\)
1474
1475 (defvar hs-lint-regex
1476   "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1477   "Regex for HLint messages")
1478
1479 (defun make-short-string (str maxlen)
1480   (if (< (length str) maxlen)
1481       str
1482     (concat (substring str 0 (- maxlen 3)) "...")))
1483
1484 (defun hs-lint-replace-suggestions ()
1485   "Perform actual replacement of suggestions"
1486   (goto-char (point-min))
1487   (while (re-search-forward hs-lint-regex nil t)
1488     (let* ((fname (match-string 1))
1489           (fline (string-to-number (match-string 2)))
1490           (old-code (match-string 4))
1491           (new-code (match-string 5))
1492           (msg (concat "Replace '" (make-short-string old-code 30)
1493                        "' with '" (make-short-string new-code 30) "'"))
1494           (bline 0)
1495           (eline 0)
1496           (spos 0)
1497           (new-old-code ""))
1498       (save-excursion
1499         (switch-to-buffer (get-file-buffer fname))
1500         (goto-char (point-min))
1501         (forward-line (1- fline))
1502         (beginning-of-line)
1503         (setf bline (point))
1504         (when (or hs-lint-replace-without-ask
1505                   (yes-or-no-p msg))
1506           (end-of-line)
1507           (setf eline (point))
1508           (beginning-of-line)
1509           (setf old-code (regexp-quote old-code))
1510           (while (string-match "\\\\ " old-code spos)
1511             (setf new-old-code (concat new-old-code
1512                                  (substring old-code spos (match-beginning 0))
1513                                  "\\ *"))
1514             (setf spos (match-end 0)))
1515           (setf new-old-code (concat new-old-code (substring old-code spos)))
1516           (remove-text-properties bline eline '(composition nil))
1517           (when (re-search-forward new-old-code eline t)
1518             (replace-match new-code nil t)))))))
1519
1520 (defun hs-lint-finish-hook (buf msg)
1521   "Function, that is executed at the end of HLint execution"
1522   (if hs-lint-replace-with-suggestions
1523       (hs-lint-replace-suggestions)
1524       (next-error 1 t)))
1525
1526 (define-compilation-mode hs-lint-mode "HLint"
1527   "Mode for check Haskell source code."
1528   (set (make-local-variable 'compilation-process-setup-function)
1529        'hs-lint-process-setup)
1530   (set (make-local-variable 'compilation-disable-input) t)
1531   (set (make-local-variable 'compilation-scroll-output) nil)
1532   (set (make-local-variable 'compilation-finish-functions)
1533        (list 'hs-lint-finish-hook))
1534   )
1535
1536 (defun hs-lint ()
1537   "Run HLint for current buffer with haskell source"
1538   (interactive)
1539   (save-some-buffers hs-lint-save-files)
1540   (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1541                      'hs-lint-mode))
1542
1543 (provide 'hs-lint)
1544 ;;; hs-lint.el ends here
1545 #+end_src
1546
1547 #+begin_src emacs-lisp :tangle no
1548 (use-package hs-lint
1549   :load-path "lisp/"
1550   :bind (:map haskell-mode-map
1551               ("C-c l l" . hs-lint)))
1552 #+end_src
1553
1554 ** Web dev
1555
1556 *** SGML and HTML
1557
1558 #+begin_src emacs-lisp
1559 (use-package sgml-mode
1560   :defer t
1561   :config
1562   (setq sgml-basic-offset 2))
1563 #+end_src
1564
1565 *** CSS and SCSS
1566
1567 #+begin_src emacs-lisp
1568 (use-package css-mode
1569   :defer t
1570   :config
1571   (setq css-indent-offset 2))
1572 #+end_src
1573
1574 *** Web mode
1575
1576 #+begin_src emacs-lisp
1577 (use-package web-mode
1578   :defer t
1579   :mode "\\.html\\'"
1580   :config
1581   (setq-every! 2
1582     web-mode-code-indent-offset
1583     web-mode-css-indent-offset
1584     web-mode-markup-indent-offset))
1585 #+end_src
1586
1587 *** Emmet mode
1588
1589 #+begin_src emacs-lisp
1590 (use-package emmet-mode
1591   :after (:any web-mode css-mode sgml-mode)
1592   :bind* (("C-)" . emmet-next-edit-point)
1593           ("C-(" . emmet-prev-edit-point))
1594   :config
1595   (unbind-key "C-j" emmet-mode-keymap)
1596   (setq emmet-move-cursor-between-quotes t)
1597   :hook (web-mode css-mode html-mode sgml-mode))
1598 #+end_src
1599
1600 ** Nix
1601
1602 #+begin_src emacs-lisp
1603 (use-package nix-mode
1604   :defer t
1605   :mode "\\.nix\\'")
1606 #+end_src
1607
1608 ** Java
1609
1610 *** meghanada
1611
1612 #+begin_src emacs-lisp :tangle no
1613 (use-package meghanada
1614   :bind
1615   (:map meghanada-mode-map
1616         (("C-M-o" . meghanada-optimize-import)
1617          ("C-M-t" . meghanada-import-all)))
1618   :hook (java-mode . meghanada-mode))
1619 #+end_src
1620
1621 *** lsp-java
1622
1623 #+begin_comment
1624 dependencies:
1625
1626 ace-window
1627 avy
1628 bui
1629 company-lsp
1630 dap-mode
1631 lsp-java
1632 lsp-mode
1633 lsp-ui
1634 pfuture
1635 tree-mode
1636 treemacs
1637 #+end_comment
1638
1639 #+begin_src emacs-lisp :tangle no
1640 (use-package treemacs
1641   :config (setq treemacs-never-persist t))
1642
1643 (use-package yasnippet
1644   :config
1645   ;; (yas-global-mode)
1646   )
1647
1648 (use-package lsp-mode
1649   :init (setq lsp-eldoc-render-all nil
1650               lsp-highlight-symbol-at-point nil)
1651   )
1652
1653 (use-package hydra)
1654
1655 (use-package company-lsp
1656   :after  company
1657   :config
1658   (setq company-lsp-cache-candidates t
1659         company-lsp-async t))
1660
1661 (use-package lsp-ui
1662   :config
1663   (setq lsp-ui-sideline-update-mode 'point))
1664
1665 (use-package lsp-java
1666   :config
1667   (add-hook 'java-mode-hook
1668             (lambda ()
1669               (setq-local company-backends (list 'company-lsp))))
1670
1671   (add-hook 'java-mode-hook 'lsp-java-enable)
1672   (add-hook 'java-mode-hook 'flycheck-mode)
1673   (add-hook 'java-mode-hook 'company-mode)
1674   (add-hook 'java-mode-hook 'lsp-ui-mode))
1675
1676 (use-package dap-mode
1677   :after lsp-mode
1678   :config
1679   (dap-mode t)
1680   (dap-ui-mode t))
1681
1682 (use-package dap-java
1683   :after (lsp-java))
1684
1685 (use-package lsp-java-treemacs
1686   :after (treemacs))
1687 #+end_src
1688
1689 * Emacs Enhancements
1690
1691 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1692
1693 #+begin_quote
1694 Emacs package that displays available keybindings in popup
1695 #+end_quote
1696
1697 #+begin_src emacs-lisp
1698 (use-package which-key
1699   :defer 1
1700   :config (which-key-mode))
1701 #+end_src
1702
1703 ** [[https://github.com/Malabarba/smart-mode-line][smart-mode-line]]
1704
1705 #+begin_src emacs-lisp
1706 (use-package smart-mode-line
1707   :config
1708   (sml/setup)
1709   ;; (sml/apply-theme 'light)
1710   (remove-hook 'display-time-hook 'sml/propertize-time-string))
1711 #+end_src
1712
1713 ** [[https://github.com/bbatsov/crux][crux]]
1714
1715 #+begin_src emacs-lisp
1716 (use-package crux
1717   :defer 1
1718   :general
1719   (amin--leader-keys
1720     "b K" 'crux-kill-other-buffers
1721     "c d" 'crux-duplicate-current-line-or-region
1722     "c D" 'crux-duplicate-and-comment-current-line-or-region
1723     "f c" 'crux-copy-file-preserve-attributes
1724     "f d" 'crux-delete-file-and-buffer
1725     "f r" 'crux-rename-file-and-buffer)
1726   :bind (("C-c d" . crux-duplicate-current-line-or-region)
1727          ("C-c D" . crux-duplicate-and-comment-current-line-or-region)
1728          ("C-S-j" . crux-top-join-line)
1729          ("C-c j" . crux-top-join-line)))
1730 #+end_src
1731
1732 ** [[https://github.com/alezost/mwim.el][mwim]]
1733
1734 #+begin_src emacs-lisp
1735 (use-package mwim
1736   :general
1737   (:states '(normal visual)
1738            "0" 'mwim-beginning-of-code-or-line
1739            "$" 'mwim-end-of-code-or-line)
1740   :bind (("C-a"    . mwim-beginning-of-code-or-line)
1741          ("C-e"    . mwim-end-of-code-or-line)
1742          ("<home>" . mwim-beginning-of-line-or-code)
1743          ("<end>"  . mwim-end-of-line-or-code)))
1744 #+end_src
1745
1746 ** projectile
1747
1748 #+begin_src emacs-lisp
1749 (use-package projectile
1750   :defer 2
1751   :bind-keymap ("C-c p" . projectile-command-map)
1752   :config
1753   (projectile-mode)
1754
1755   (defun my-projectile-invalidate-cache (&rest _args)
1756     ;; ignore the args to `magit-checkout'
1757     (projectile-invalidate-cache nil))
1758
1759   (eval-after-load 'magit-branch
1760     '(progn
1761        (advice-add 'magit-checkout
1762                    :after #'my-projectile-invalidate-cache)
1763        (advice-add 'magit-branch-and-checkout
1764                    :after #'my-projectile-invalidate-cache))))
1765 #+end_src
1766
1767 ** [[https://github.com/Wilfred/helpful][helpful]]
1768
1769 #+begin_src emacs-lisp
1770 (use-package helpful
1771   :defer 1
1772   :general
1773   (amin--leader-keys
1774     "h h"   '(:ignore t :wk "helpful")
1775     "h h c" 'helpful-command
1776     "h h f" 'helpful-callable           ; helpful-function
1777     "h h v" 'helpful-variable
1778     "h h k" 'helpful-key
1779     "h h p" 'helpful-at-point))
1780 #+end_src
1781
1782 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1783
1784 #+begin_src emacs-lisp
1785 (use-package shell-pop
1786   :defer 1
1787   :init
1788   (setq shell-pop-universal-key "C-c e"
1789         shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1790 #+end_src
1791
1792 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1793
1794 Make =*scratch*= and =*Messages*= unkillable.
1795
1796 #+begin_src emacs-lisp
1797 (use-package unkillable-scratch
1798   :defer 3
1799   :config
1800   (unkillable-scratch 1)
1801   :custom
1802   (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1803 #+end_src
1804
1805 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1806
1807 #+begin_example
1808 ,----
1809 | make pretty boxed quotes like this
1810 `----
1811 #+end_example
1812
1813 #+begin_src emacs-lisp
1814 (use-package boxquote
1815   :defer 3
1816   :bind
1817   (:prefix-map amin--boxquote-prefix-map
1818    :prefix "C-c q"
1819    ("b"   . boxquote-buffer)
1820    ("B"   . boxquote-insert-buffer)
1821    ("d"   . boxquote-defun)
1822    ("F"   . boxquote-insert-file)
1823    ("hf"  . boxquote-describe-function)
1824    ("hk"  . boxquote-describe-key)
1825    ("hv"  . boxquote-describe-variable)
1826    ("hw"  . boxquote-where-is)
1827    ("k"   . boxquote-kill)
1828    ("p"   . boxquote-paragraph)
1829    ("q"   . boxquote-boxquote)
1830    ("r"   . boxquote-region)
1831    ("s"   . boxquote-shell-command)
1832    ("t"   . boxquote-text)
1833    ("T"   . boxquote-title)
1834    ("u"   . boxquote-unbox)
1835    ("U"   . boxquote-unbox-region)
1836    ("y"   . boxquote-yank)
1837    ("M-q" . boxquote-fill-paragraph)
1838    ("M-w" . boxquote-kill-ring-save)))
1839 #+end_src
1840
1841 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1842
1843 ** COMMENT [[https://github.com/DarthFennec/highlight-indent-guides][highlight-indent-guides]]                                 :ARCHIVE:
1844
1845 #+begin_src emacs-lisp
1846 (use-package highlight-indent-guides
1847   :defer 3
1848   :hook ((prog-mode . highlight-indent-guides-mode)
1849          ;; (org-mode  . highlight-indent-guides-mode)
1850          )
1851   :config
1852   (setq highlight-indent-guides-character ?\|)
1853   (setq highlight-indent-guides-auto-enabled nil)
1854   (setq highlight-indent-guides-method 'character)
1855   (setq highlight-indent-guides-responsive 'top)
1856   (set-face-foreground 'highlight-indent-guides-character-face "gainsboro")
1857   (set-face-foreground 'highlight-indent-guides-top-character-face "grey40")) ; grey13 is nice too
1858 #+end_src
1859
1860 ** pdf-tools
1861
1862 #+begin_src emacs-lisp
1863 (use-package pdf-tools
1864   :defer t
1865   :magic ("%PDF" . pdf-view-mode)
1866   :config
1867   (setq pdf-view-resize-factor 1.05)
1868   (pdf-tools-install)
1869   :bind
1870   (:map pdf-view-mode-map
1871         ("C-s" . isearch-forward)
1872         ("C-r" . isearch-backward)
1873         ("j"   . pdf-view-next-line-or-next-page)
1874         ("k"   . pdf-view-previous-line-or-previous-page)
1875         ("h"   . image-backward-hscroll)
1876         ("l"   . image-forward-hscroll)))
1877 #+end_src
1878
1879 ** anzu
1880
1881 #+begin_src emacs-lisp
1882 (use-package anzu)
1883 #+end_src
1884
1885 ** typo.el
1886
1887 #+begin_src emacs-lisp
1888 (use-package typo
1889   :defer 2
1890   :config
1891   (typo-global-mode 1)
1892   :hook (text-mode . typo-mode))
1893 #+end_src
1894
1895 ** slack
1896
1897 Hopefully temporary.
1898
1899 #+begin_src emacs-lisp
1900 (use-package slack
1901   :commands (slack-start)
1902   :init
1903   (eval-when-compile                    ; silence the byte-compiler
1904     (defvar url-http-data nil)
1905     (defvar url-http-extra-headers nil)
1906     (defvar url-http-method nil)
1907     (defvar url-callback-function nil)
1908     (defvar url-callback-arguments nil)
1909     (defvar oauth--token-data nil))
1910   (setq slack-buffer-emojify t
1911         slack-prefer-current-team t)
1912   :config
1913   (slack-register-team
1914    :name "uw-apv"
1915    :default t
1916    :client-id uw-apv-client-id
1917    :client-secret uw-apv-client-secret
1918    :token uw-apv-token
1919    :subscribed-channels '(general)
1920    :full-and-display-names t)
1921   (slack-register-team
1922    :name "watform"
1923    :default nil
1924    :client-id watform-client-id
1925    :client-secret watform-client-secret
1926    :token watform-token
1927    :subscribed-channels '(general)
1928    :full-and-display-names t)
1929   (add-to-list 'swiper-font-lock-exclude 'slack-message-buffer-mode t)
1930   (setq lui-time-stamp-format "[%Y-%m-%d %H:%M:%S]"
1931         lui-time-stamp-only-when-changed-p t
1932         lui-time-stamp-position 'right)
1933   :bind
1934   (("C-c s s" . slack-start)
1935    ("C-c s u" . slack-select-unread-rooms)
1936    ("C-c s b" . slack-select-rooms)
1937    ("C-c s t" . slack-change-current-team)
1938    ("C-c s c" . slack-ws-close)
1939    :map slack-mode-map
1940    ("M-p"     . slack-buffer-goto-prev-message)
1941    ("M-n"     . slack-buffer-goto-next-message)
1942    ("C-c e"   . slack-message-edit)
1943    ("C-c k"   . slack-message-delete)
1944    ("C-c C-k" . slack-channel-leave)
1945    ("C-c r a" . slack-message-add-reaction)
1946    ("C-c r r" . slack-message-remove-reaction)
1947    ("C-c r s" . slack-message-show-reaction-users)
1948    ("C-c p l" . slack-room-pins-list)
1949    ("C-c p a" . slack-message-pins-add)
1950    ("C-c p r" . slack-message-pins-remove)
1951    ("@"       . slack-message-embed-mention)
1952    ("#"       . slack-message-embed-channel)))
1953
1954 (use-package alert
1955   :commands (alert)
1956   :init
1957   (setq alert-default-style 'notifier))
1958 #+end_src
1959
1960 ** hl-todo
1961
1962 #+begin_src emacs-lisp
1963 (use-package hl-todo
1964   :defer 4
1965   :config
1966   (global-hl-todo-mode))
1967 #+end_src
1968
1969 ** shrink-path
1970
1971 #+begin_src emacs-lisp
1972 (use-package shrink-path
1973   :after eshell
1974   :config
1975   (setq eshell-prompt-regexp "\\(.*\n\\)*λ "
1976         eshell-prompt-function #'+eshell/prompt)
1977
1978   (defun +eshell/prompt ()
1979     (let ((base/dir (shrink-path-prompt default-directory)))
1980       (concat (propertize (car base/dir)
1981                           'face 'font-lock-comment-face)
1982               (propertize (cdr base/dir)
1983                           'face 'font-lock-constant-face)
1984               (propertize (+eshell--current-git-branch)
1985                           'face 'font-lock-function-name-face)
1986               "\n"
1987               (propertize "λ" 'face 'eshell-prompt-face)
1988               ;; needed for the input text to not have prompt face
1989               (propertize " " 'face 'default))))
1990
1991   (defun +eshell--current-git-branch ()
1992     (let ((branch (car (loop for match in (split-string (shell-command-to-string "git branch") "\n")
1993                              when (string-match "^\*" match)
1994                              collect match))))
1995       (if (not (eq branch nil))
1996           (concat " " (substring branch 2))
1997         ""))))
1998 #+end_src
1999
2000 ** magithub
2001
2002 For when I /have to/ use GH.
2003
2004 #+begin_src emacs-lisp
2005 (use-package magithub
2006   :after magit
2007   :config
2008   (magithub-feature-autoinject t)
2009   (setq magithub-clone-default-directory "~/src/git"))
2010 #+end_src
2011
2012 ** [[https://github.com/peterwvj/eshell-up][eshell-up]]
2013
2014 #+begin_src emacs-lisp
2015 (use-package eshell-up
2016   :after eshell)
2017 #+end_src
2018
2019 * Email
2020
2021 #+begin_src emacs-lisp
2022 (defvar amin-maildir (expand-file-name "~/mail/"))
2023 (after! recentf
2024   (add-to-list 'recentf-exclude amin-maildir))
2025 #+end_src
2026
2027 ** Gnus
2028
2029 #+begin_src emacs-lisp
2030 (setq
2031  amin-gnus-init-file (no-littering-expand-etc-file-name "gnus")
2032  mail-user-agent     'gnus-user-agent
2033  read-mail-command   'gnus)
2034
2035 (use-package gnus
2036   :general
2037   (amin--leader-keys
2038     "m" 'gnus
2039     "M" 'gnus-unplugged)
2040   :bind (("s-m" . gnus)
2041          ("s-M" . gnus-unplugged))
2042   :init
2043   (setq
2044    gnus-select-method '(nnnil "")
2045    gnus-secondary-select-methods
2046    '((nnimap "amin"
2047             (nnimap-stream plain)
2048             (nnimap-address "127.0.0.1")
2049             (nnimap-server-port 143)
2050             (nnimap-authenticator plain)
2051             (nnimap-user "amin@aminb.org"))
2052      (nnimap "uwaterloo"
2053              (nnimap-stream plain)
2054              (nnimap-address "127.0.0.1")
2055              (nnimap-server-port 143)
2056              (nnimap-authenticator plain)
2057              (nnimap-user "abandali@uwaterloo.ca")))
2058    gnus-message-archive-group "nnimap:Sent"
2059    gnus-parameters
2060    '(("gnu.*"
2061       (gcc-self . t)))
2062    gnus-large-newsgroup  50
2063    gnus-home-directory   (no-littering-expand-var-file-name "gnus/")
2064    gnus-directory        (concat gnus-home-directory "news/")
2065    message-directory     (concat gnus-home-directory "mail/")
2066    nndraft-directory     (concat gnus-home-directory "drafts/")
2067    gnus-save-newsrc-file nil
2068    gnus-read-newsrc-file nil
2069    gnus-interactive-exit nil
2070    gnus-gcc-mark-as-read t))
2071
2072 (use-package gnus-art
2073   :config
2074   (setq
2075    gnus-visible-headers
2076    (concat gnus-visible-headers "\\|^List-Id:\\|^X-RT-Originator:\\|^User-Agent:")
2077    gnus-sorted-header-list
2078    '("^From:" "^Subject:" "^Summary:" "^Keywords:"
2079      "^Followup-To:" "^To:" "^Cc:" "X-RT-Originator"
2080      "^Newsgroups:" "List-Id:" "^Organization:"
2081      "^User-Agent:" "^Date:")
2082   ;; local-lapsed article dates
2083   ;; from https://www.emacswiki.org/emacs/GnusFormatting#toc11
2084   gnus-article-date-headers '(user-defined)
2085   gnus-article-time-format
2086   (lambda (time)
2087     (let* ((date (format-time-string "%a, %d %b %Y %T %z" time))
2088            (local (article-make-date-line date 'local))
2089            (combined-lapsed (article-make-date-line date
2090                                                     'combined-lapsed))
2091            (lapsed (progn
2092                      (string-match " (.+" combined-lapsed)
2093                      (match-string 0 combined-lapsed))))
2094       (concat local lapsed))))
2095   (bind-keys
2096    :map gnus-article-mode-map
2097    ("r"   . gnus-article-reply-with-original)
2098    ("R"   . gnus-article-wide-reply-with-original)
2099    ("M-L" . org-store-link)))
2100
2101 (use-package gnus-sum
2102   :bind (:map gnus-summary-mode-map
2103               :prefix-map amin--gnus-summary-prefix-map
2104               :prefix "v"
2105               ("r" . gnus-summary-reply)
2106               ("w" . gnus-summary-wide-reply)
2107               ("v" . gnus-summary-show-raw-article))
2108   :config
2109   (bind-keys
2110    :map gnus-summary-mode-map
2111    ("r"   . gnus-summary-reply-with-original)
2112    ("R"   . gnus-summary-wide-reply-with-original)
2113    ("M-L" . org-store-link)))
2114
2115 (use-package gnus-msg
2116   :config
2117   (setq gnus-posting-styles
2118         '((".*"
2119            (address "amin@aminb.org")
2120            (body "\nBest,\namin\n"))
2121           ("gnu.*"
2122            (address "bandali@gnu.org"))
2123           ((header "subject" "ThankCRM")
2124            (to "webmasters-comment@gnu.org"))
2125           ("nnimap\\+uwaterloo:.*"
2126            (address "abandali@uwaterloo.ca")
2127            (gcc "\"nnimap+uwaterloo:Sent Items\"")))))
2128
2129 (use-package gnus-topic
2130   :hook (gnus-group-mode . gnus-topic-mode))
2131
2132 (use-package gnus-agent
2133   :config
2134   (setq gnus-agent-synchronize-flags 'ask)
2135   :hook (gnus-group-mode . gnus-agent-mode))
2136
2137 (use-package gnus-group
2138   :config
2139   (setq gnus-permanently-visible-groups "\\((INBOX\\|gnu$\\)"))
2140
2141 (use-package mm-decode
2142   :config
2143   (setq mm-discouraged-alternatives '("text/html" "text/richtext")))
2144 #+end_src
2145
2146 ** sendmail
2147
2148 #+begin_src emacs-lisp
2149 (use-package sendmail
2150   :config
2151   (setq sendmail-program "/usr/bin/msmtp"
2152         ;; message-sendmail-extra-arguments '("-v" "-d")
2153         mail-specify-envelope-from t
2154         mail-envelope-from 'header))
2155 #+end_src
2156
2157 ** message
2158
2159 #+begin_src emacs-lisp
2160 (use-package message
2161   :config
2162   (defconst message-cite-style-bandali
2163     '((message-cite-function  'message-cite-original)
2164       (message-citation-line-function  'message-insert-formatted-citation-line)
2165       (message-cite-reply-position 'traditional)
2166       (message-yank-prefix  "> ")
2167       (message-yank-cited-prefix  ">")
2168       (message-yank-empty-prefix  ">")
2169       (message-citation-line-format "Hi %F,\n\nOn %Y-%m-%d %l:%M %p, %N wrote:"))
2170     "Citation style based on Mozilla Thunderbird's. Use with message-cite-style.")
2171   (setq message-cite-style 'message-cite-style-bandali
2172         message-kill-buffer-on-exit t
2173         message-send-mail-function 'message-send-mail-with-sendmail
2174         message-sendmail-envelope-from 'header
2175         message-dont-reply-to-names
2176         "\\(\\(.*@aminb\\.org\\)\\|\\(\\(aminb?\\|mab\\|bandali\\)@gnu\\.org\\)\\|\\(\\(m\\|a\\(min\\.\\)?\\)bandali@uwaterloo\\.ca\\)\\)"
2177         message-user-fqdn "aminb.org")
2178   :hook (;; (message-setup . mml-secure-message-sign-pgpmime)
2179          (message-mode . flyspell-mode)
2180          (message-mode . (lambda () (setq fill-column 65
2181                                      message-fill-column 65))))
2182   :custom-face
2183   (message-header-subject ((t (:foreground "#111" :weight semi-bold))))
2184   (message-header-to      ((t (:foreground "#111" :weight normal))))
2185   (message-header-cc      ((t (:foreground "#333" :weight normal)))))
2186
2187 (after! mml-sec
2188   (setq mml-secure-openpgp-encrypt-to-self t
2189         mml-secure-openpgp-sign-with-sender t))
2190 #+end_src
2191
2192 ** footnote
2193
2194 Convenient footnotes in =message-mode=.
2195
2196 #+begin_src emacs-lisp
2197 (use-package footnote
2198   :after message
2199   :bind
2200   (:map message-mode-map
2201         :prefix-map amin--footnote-prefix-map
2202         :prefix "C-c f"
2203         ("a" . footnote-add-footnote)
2204         ("b" . footnote-back-to-message)
2205         ("c" . footnote-cycle-style)
2206         ("d" . footnote-delete-footnote)
2207         ("g" . footnote-goto-footnote)
2208         ("r" . footnote-renumber-footnotes)
2209         ("s" . footnote-set-style))
2210   :config
2211   (setq footnote-start-tag ""
2212         footnote-end-tag   ""
2213         footnote-style     'unicode))
2214 #+end_src
2215
2216 ** COMMENT supercite
2217
2218 #+begin_src emacs-lisp
2219 (use-package supercite
2220   :after message
2221   :init
2222   (setq sc-nested-citation-p t
2223         ;; sc-cite-blank-lines-p t
2224         sc-citation-leader ""
2225         sc-reference-tag-string ""
2226         sc-preferred-header-style 5     ; (sc-header-author-writes)
2227         sc-auto-fill-region-p nil
2228         sc-confirm-always-p nil)
2229   :config
2230   ;;   (defun amin--sc-header-on-wrote ()
2231   ;;     "\"On <date>, <sc-author> wrote:\" unless:
2232   ;; 1. the \"sc-author\" field cannot be found, in which case nothing is inserted;
2233   ;; 2. the \"date\" field is missing in which case only the from part is printed."
2234   ;;     (let ((sc-mumble "")
2235   ;;          (whofrom (sc-whofrom)))
2236   ;;       (if whofrom
2237   ;;          (insert sc-reference-tag-string
2238   ;;                      (sc-hdr "On " (sc-mail-field "date") ", ")
2239   ;;                      (sc-hdr "" (sc-mail-field "sc-author")) " wrote:\n"))))
2240   ;;   (defun amin--sc-header ()
2241   ;;     "Hi <firstname>,\n\n <from> writes:"
2242   ;;     (let ((sc-mumble "")
2243   ;;          (whofrom (sc-whofrom)))
2244   ;;       (if whofrom
2245   ;;          (insert (sc-hdr "Hi " (sc-mail-field "sc-firstname") ",\n\n")
2246   ;;                   sc-reference-tag-string
2247   ;;                      whofrom
2248   ;;                      " writes:\n"))))
2249   ;; (add-to-list 'sc-rewrite-header-list '(amin--sc-header) t)
2250   ;; (add-to-list 'sc-rewrite-header-list '(amin--sc-header-on-wrote) t)
2251   ;; (setq sc-preferred-header-style (1- (length sc-rewrite-header-list)))
2252   (add-hook 'mail-citation-hook 'sc-cite-original))
2253 #+end_src
2254
2255 ** ebdb
2256
2257 #+begin_src emacs-lisp
2258 (use-package ebdb
2259   :defer 1
2260   :bind (:map gnus-group-mode-map ("e" . ebdb))
2261   :config
2262   (setq ebdb-sources (no-littering-expand-var-file-name "ebdb")))
2263
2264 (use-package ebdb-com
2265   :after ebdb)
2266
2267 (use-package ebdb-complete
2268   :after ebdb
2269   :config
2270   (ebdb-complete-enable))
2271
2272 (use-package ebdb-gnus
2273   :after ebdb)
2274
2275 (use-package ebdb-message
2276   :after ebdb)
2277
2278 ;; (use-package ebdb-vcard
2279 ;;   :after ebdb)
2280 #+end_src
2281
2282 ** COMMENT bbdb
2283
2284 #+begin_comment
2285 [submodule "bbdb"]
2286         path = lib/bbdb
2287         url = https://git.savannah.nongnu.org/git/bbdb.git
2288         load-path = lisp/elisp
2289         info-path = doc
2290         build-step = ./autogen.sh
2291         build-step = ./configure --with-lispdir=elisp
2292         build-step = make
2293         build-step = make install
2294 #+end_comment
2295
2296 #+begin_src emacs-lisp
2297 (use-package bbdb
2298   :init
2299   (bbdb-mua-auto-update-init 'message)
2300   (setq bbdb-mua-auto-update-p 'query)
2301   (add-hook 'gnus-startup-hook 'bbdb-insinuate-gnus))
2302 #+end_src
2303
2304 ** COMMENT message-x
2305
2306 #+begin_src emacs-lisp
2307 (use-package message-x
2308   :custom
2309   (message-x-completion-alist
2310    (quote
2311     (("\\([rR]esent-\\|[rR]eply-\\)?[tT]o:\\|[bB]?[cC][cC]:" . gnus-harvest-find-address)
2312      ((if
2313           (boundp
2314            (quote message-newgroups-header-regexp))
2315           message-newgroups-header-regexp message-newsgroups-header-regexp)
2316       . message-expand-group)))))
2317 #+end_src
2318
2319 ** COMMENT gnus-harvest
2320
2321 #+begin_src emacs-lisp
2322 (use-package gnus-harvest
2323   :commands gnus-harvest-install
2324   :demand t
2325   :config
2326   (if (featurep 'message-x)
2327       (gnus-harvest-install 'message-x)
2328     (gnus-harvest-install)))
2329 #+end_src
2330
2331 ** COMMENT gnus-alias                                              :ARCHIVE:
2332
2333 #+begin_src emacs-lisp
2334 (use-package gnus-alias
2335   :commands (gnus-alias-determine-identity
2336              gnus-alias-select-identity)
2337   :bind (:map  message-mode-map
2338                ("s-i" . gnus-alias-select-identity))
2339   :config
2340   (setq
2341    gnus-alias-default-identity "amin"
2342    gnus-alias-identity-alist
2343    '(("amin"
2344       nil   ;; Does not refer to any other identity
2345       "Amin Bandali <amin@aminb.org>"
2346       nil   ;; Organization
2347       nil   ;; extra headers
2348       nil   ;; extra body text
2349       nil)  ;; signature file
2350      ("gnu"
2351       nil
2352       "Amin Bandali <bandali@gnu.org>"
2353       nil
2354       nil
2355       nil
2356       nil)
2357      ("uw"
2358       nil
2359       "Amin Bandali <abandali@uwaterloo.ca>"
2360       nil
2361       (("Gcc" . "\"nnimap+uwaterloo:Sent Items\""))
2362       nil
2363       nil))
2364    gnus-alias-identity-rules
2365    '(("amin" ("Delivered-To" "<amin\\@aminb\\.org" both) "amin")
2366      ("gnu" ("Delivered-To" "<gnu\\@aminb\\.org" both) "gnu")
2367      ("uw" ("any" "<\\(.+\\)\\@uwaterloo\\.ca" both) "uw"))
2368    gnus-alias-override-user-mail-address t)
2369   :hook (message-setup . gnus-alias-determine-identity))
2370 #+end_src
2371
2372 ** COMMENT [[https://notmuchmail.org][notmuch]]                                                 :ARCHIVE:
2373
2374 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
2375
2376 #+begin_src emacs-lisp
2377 (defun amin/notmuch ()
2378   "Delete other windows, then launch `notmuch'."
2379   (interactive
2380    (when (equal current-prefix-arg nil)
2381      (delete-other-windows)))
2382   (notmuch))
2383
2384 (use-package notmuch
2385   :commands notmuch
2386   :bind ("C-c n" . amin/notmuch)
2387   :custom (notmuch-always-prompt-for-sender t)
2388   :config
2389   (setq notmuch-hello-sections
2390         '(notmuch-hello-insert-header
2391           notmuch-hello-insert-saved-searches
2392           ;; notmuch-hello-insert-search
2393           notmuch-hello-insert-alltags)
2394         notmuch-search-oldest-first nil
2395         notmuch-show-all-tags-list t
2396         notmuch-message-headers  ; see bug follow-up above
2397         '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
2398         notmuch-hello-thousands-separator ","
2399         notmuch-fcc-dirs
2400         '(("amin@aminb.org"        . "amin/Sent")
2401           ("bandali@gnu.org"       . "gnu/Sent")
2402           ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
2403           ("mab@gnu.org"           . "gnu/Sent")
2404           ("amin@gnu.org"          . "gnu/Sent")
2405           ("aminb@gnu.org"         . "gnu/Sent")
2406           (".*"                    . "sent"))
2407         notmuch-search-result-format
2408         '(("date"    . "%12s ")
2409           ("count"   . "%-7s ")
2410           ("authors" . "%-40s ")
2411           ("subject" . "%s ")
2412           ("tags"    . "(%s)"))
2413         notmuch-saved-searches
2414         '((:name "inbox"     :query "tag:inbox"     :key "i")
2415           (:name "unread"    :query "tag:unread"    :key "u")
2416           (:name "latest"    :query "tag:latest"    :key "l")
2417           (:name "encrypted" :query "tag:encrypted" :key "e")
2418           (:name "flagged"   :query "tag:flagged"   :key "f")
2419           (:name "sent"      :query "tag:sent"      :key "s")
2420           (:name "drafts"    :query "tag:draft"     :key "d")
2421           (:name "all mail"  :query "*"             :key "a")))
2422   ;; (add-hook 'visual-fill-column-mode-hook
2423   ;;           (lambda ()
2424   ;;             (when (string= major-mode 'notmuch-message-mode)
2425   ;;               (setq visual-fill-column-width 70))))
2426   ;; (set! :evil-state 'notmuch-message-mode 'insert)
2427   ;; (advice-add #'notmuch-bury-or-kill-this-buffer
2428   ;;             :override #'kill-this-buffer)
2429   :hook (notmuch-message-mode . doom-modeline-set-special-modeline)
2430   :bind
2431   (:map notmuch-hello-mode-map
2432         ("u" . (lambda ()
2433                  "Search for `unread'-tagged messages"
2434                  (interactive)
2435                  (notmuch-hello-search "tag:unread")))
2436         ("i" . (lambda ()
2437                  "Search for `inbox'-tagged messages"
2438                  (interactive)
2439                  (notmuch-hello-search "tag:inbox")))
2440         ("l" . (lambda ()
2441                  "Search for `latest'-tagged messages"
2442                  (interactive)
2443                  (notmuch-hello-search "tag:latest")))
2444         ("e" . (lambda ()
2445                  "Search for `encrypted'-tagged messages"
2446                  (interactive)
2447                  (notmuch-hello-search "tag:encrypted"))))
2448   (:map notmuch-search-mode-map
2449         ("k" . (lambda ()
2450                  "Mark message read"
2451                  (interactive)
2452                  (notmuch-search-tag '("-unread"))
2453                  ;; (notmuch-search-archive-thread)
2454                  (notmuch-search-next-thread)))
2455         ("u" . (lambda ()
2456                  "Mark message unread"
2457                  (interactive)
2458                  (notmuch-search-tag '("+unread"))
2459                  (notmuch-search-next-thread)))
2460         ("K" . (lambda ()
2461                  "Mark message deleted"
2462                  (interactive)
2463                  (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
2464                  (notmuch-search-next-thread)))
2465         ("S" . (lambda ()
2466                  "Mark message as spam"
2467                  (interactive)
2468                  (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
2469                  (notmuch-search-next-thread))))
2470   (:map notmuch-tree-mode-map
2471         ("k" . (lambda ()
2472                  "Mark message read"
2473                  (interactive)
2474                  (notmuch-tree-tag '("-unread"))
2475                  ;; (notmuch-tree-archive-thread)
2476                  (notmuch-tree-next-message)))
2477         ("u" . (lambda ()
2478                  "Mark message unread"
2479                  (interactive)
2480                  (notmuch-tree-tag '("+unread"))
2481                  (notmuch-tree-next-message)))
2482         ("K" . (lambda ()
2483                  "Mark message deleted"
2484                  (interactive)
2485                  (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
2486                  (notmuch-tree-next-message)))
2487         ("S" . (lambda ()
2488                  "Mark message as spam"
2489                  (interactive)
2490                  (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
2491                  (notmuch-tree-next-message))))
2492   :custom-face
2493   (notmuch-search-unread-face ((t (:weight semi-bold))))
2494   (notmuch-tag-face ((t (:foreground "navy blue" :weight semi-bold)))))
2495
2496 (use-package counsel-notmuch
2497   :bind ("C-c s m" . counsel-notmuch))
2498
2499 (after! notmuch-crypto
2500   (setq notmuch-crypto-process-mime t))
2501
2502 (use-package org-notmuch
2503   :after (:any org notmuch))
2504 #+end_src
2505
2506 * Blogging
2507 ** [[https://ox-hugo.scripter.co][ox-hugo]]
2508
2509 #+begin_src emacs-lisp
2510 (use-package ox-hugo
2511   :after ox)
2512
2513 (use-package ox-hugo-auto-export
2514   :load-path "lib/ox-hugo")
2515 #+end_src
2516
2517 * Post initialization
2518 :PROPERTIES:
2519 :CUSTOM_ID: post-initialization
2520 :END:
2521
2522 Display how long it took to load the init file.
2523
2524 #+begin_src emacs-lisp
2525 (message "Loading %s...done (%.3fs)" user-init-file
2526          (float-time (time-subtract (current-time)
2527                                     amin--before-user-init-time)))
2528 #+end_src
2529
2530 * Footer
2531 :PROPERTIES:
2532 :CUSTOM_ID: footer
2533 :END:
2534
2535 #+begin_src emacs-lisp :comments none
2536 ;;; init.el ends here
2537 #+end_src
2538
2539 * COMMENT Local Variables                                           :ARCHIVE:
2540 # Local Variables:
2541 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)
2542 # End: