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 #+end_src
 248
 249 *** =use-package=
 250
 251 #+begin_quote
 252 A use-package declaration for simplifying your .emacs
 253 #+end_quote
 254
 255 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
 256 packages (in our case especially the latter) in a neatly organized way
 257 and without compromising on performance.
 258
 259 #+begin_src emacs-lisp
 260 (require 'use-package)
 261 (if nil  ; set to t when need to debug init
 262     (setq use-package-verbose t
 263           use-package-expand-minimally nil
 264           use-package-compute-statistics t
 265           debug-on-error t)
 266   (setq use-package-verbose nil
 267         use-package-expand-minimally t))
 268 #+end_src
 269
 270 *** Epkg
 271
 272 #+begin_quote
 273 Browse the Emacsmirror package database
 274 #+end_quote
 275
 276 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
 277 database, low-level functions for querying the database, and a
 278 =package.el=-like user interface for browsing the available packages.
 279
 280 #+begin_src emacs-lisp
 281 (use-package epkg
 282   :defer t
 283   :bind
 284   (("C-c B d" . epkg-describe-package)
 285    ("C-c B p" . epkg-list-packages)
 286    ("C-c B r" . borg-remove)
 287    ("C-c B u" . epkg-update)))
 288 #+end_src
 289
 290 ** No littering in =~/.emacs.d=
 291
 292 #+begin_quote
 293 Help keeping ~/.emacs.d clean
 294 #+end_quote
 295
 296 By default, even for Emacs' built-in packages, the configuration files
 297 and persistent data are all over the place. Use =no-littering= to help
 298 contain the mess.
 299
 300 #+begin_src emacs-lisp
 301 (use-package no-littering
 302   :demand t
 303   :config
 304   (savehist-mode 1)
 305   (add-to-list 'savehist-additional-variables 'kill-ring)
 306   (save-place-mode 1)
 307   (setq auto-save-file-name-transforms
 308         `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
 309 #+end_src
 310
 311 ** Custom file (=custom.el=)
 312
 313 I'm not planning on using the custom file much, but even so, I
 314 definitely don't want it mixing with =init.el=. So, here; let's give
 315 it it's own file. While at it, treat themes as safe.
 316
 317 #+begin_src emacs-lisp
 318 (use-package custom
 319   :no-require t
 320   :config
 321   (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
 322   (when (file-exists-p custom-file)
 323     (load custom-file))
 324   (setf custom-safe-themes t))
 325 #+end_src
 326
 327 ** Better =$PATH= handling
 328
 329 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
 330 in my shell.
 331
 332 #+begin_src emacs-lisp
 333 (use-package exec-path-from-shell
 334   :defer 1
 335   :init
 336   (setq exec-path-from-shell-check-startup-files nil)
 337   :config
 338   (exec-path-from-shell-initialize)
 339   ;; while we're at it, let's fix access to our running ssh-agent
 340   (exec-path-from-shell-copy-env "SSH_AGENT_PID")
 341   (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
 342 #+end_src
 343
 344 ** Only one custom theme at a time
 345
 346 #+begin_src emacs-lisp
 347 (defadvice load-theme (before clear-previous-themes activate)
 348   "Clear existing theme settings instead of layering them"
 349   (mapc #'disable-theme custom-enabled-themes))
 350 #+end_src
 351
 352 ** Server
 353
 354 Start server if not already running. Alternatively, can be done by
 355 issuing =emacs --daemon= in the terminal, which can be automated with
 356 a systemd service or using =brew services start emacs= on macOS. I use
 357 Emacs as my window manager (via EXWM), so I always start Emacs on
 358 login; so starting the server from inside Emacs is good enough for me.
 359
 360 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
 361
 362 #+begin_src emacs-lisp
 363 (use-package server
 364   :config (or (server-running-p) (server-mode)))
 365 #+end_src
 366
 367 ** Unicode support
 368
 369 Font stack with better unicode support, around =Ubuntu Mono= and
 370 =Hack=.
 371
 372 #+begin_src emacs-lisp
 373 (dolist (ft (fontset-list))
 374   (set-fontset-font
 375    ft
 376    'unicode
 377    (font-spec :name "Ubuntu Mono"))
 378   (set-fontset-font
 379    ft
 380    'unicode
 381    (font-spec :name "DejaVu Sans Mono")
 382    nil
 383    'append)
 384   ;; (set-fontset-font
 385   ;;  ft
 386   ;;  'unicode
 387   ;;  (font-spec
 388   ;;   :name "Symbola monospacified for DejaVu Sans Mono")
 389   ;;  nil
 390   ;;  'append)
 391   ;; (set-fontset-font
 392   ;;  ft
 393   ;;  #x2115  ; ℕ
 394   ;;  (font-spec :name "DejaVu Sans Mono")
 395   ;;  nil
 396   ;;  'append)
 397   (set-fontset-font
 398    ft
 399    (cons ?Α ?ω)
 400    (font-spec :name "DejaVu Sans Mono" :size 14)
 401    nil
 402    'prepend))
 403 #+end_src
 404
 405 ** Libraries
 406
 407 #+begin_src emacs-lisp
 408 (require 'cl-lib)
 409 (require 'subr-x)
 410 #+end_src
 411
 412 ** Useful utilities
 413
 414 #+begin_src emacs-lisp
 415 (defun amin-enlist (exp)
 416   "Return EXP wrapped in a list, or as-is if already a list."
 417 (if (listp exp) exp (list exp)))
 418
 419 ; from https://github.com/hlissner/doom-emacs/commit/589108fdb270f24a98ba6209f6955fe41530b3ef
 420 (defmacro after! (features &rest body)
 421   "A smart wrapper around `with-eval-after-load'. Supresses warnings during
 422 compilation."
 423   (declare (indent defun) (debug t))
 424   (list (if (or (not (bound-and-true-p byte-compile-current-file))
 425                 (dolist (next (amin-enlist features))
 426                   (if (symbolp next)
 427                       (require next nil :no-error)
 428                     (load next :no-message :no-error))))
 429             #'progn
 430           #'with-no-warnings)
 431         (cond ((symbolp features)
 432                `(eval-after-load ',features '(progn ,@body)))
 433               ((and (consp features)
 434                     (memq (car features) '(:or :any)))
 435                `(progn
 436                   ,@(cl-loop for next in (cdr features)
 437                              collect `(after! ,next ,@body))))
 438               ((and (consp features)
 439                     (memq (car features) '(:and :all)))
 440                (dolist (next (cdr features))
 441                  (setq body `(after! ,next ,@body)))
 442                body)
 443               ((listp features)
 444                `(after! (:all ,@features) ,@body)))))
 445 #+end_src
 446
 447 Convenience macro for =setq='ing multiple variables to the same value:
 448
 449 #+begin_src emacs-lisp
 450 (defmacro setq-every! (value &rest vars)
 451   "Set all the variables from VARS to value VALUE."
 452   (declare (indent defun) (debug t))
 453   `(progn ,@(mapcar (lambda (x) (list 'setq x value)) vars)))
 454 #+end_src
 455
 456 * Core
 457 :PROPERTIES:
 458 :CUSTOM_ID: core
 459 :END:
 460
 461 ** Defaults
 462
 463 *** Time and battery in mode-line
 464
 465 Enable displaying time and battery in the mode-line, since I'm not
 466 using the Xfce panel anymore. Also, I don't need to see the load
 467 average on a regular basis, so disable that.
 468
 469 Note: using =i3status= on sway at the moment, so disabling this.
 470
 471 #+begin_src emacs-lisp :tangle no
 472 (use-package time
 473   :init
 474   (setq display-time-default-load-average nil)
 475   :config
 476   (display-time-mode))
 477
 478 (use-package battery
 479   :config
 480   (display-battery-mode))
 481 #+end_src
 482
 483 *** Smaller fringe
 484
 485 Might want to set the fringe to a smaller value, especially if using
 486 EXWM. I'm fine with the default for now.
 487
 488 #+begin_src emacs-lisp
 489 ;; (fringe-mode '(3 . 1))
 490 (fringe-mode nil)
 491 #+end_src
 492
 493 *** Disable disabled commands
 494
 495 Emacs disables some commands by default that could persumably be
 496 confusing for novice users. Let's disable that.
 497
 498 #+begin_src emacs-lisp
 499 (setq disabled-command-function nil)
 500 #+end_src
 501
 502 *** Kill-ring
 503
 504 Save what I copy into clipboard from other applications into Emacs'
 505 kill-ring, which would allow me to still be able to easily access it
 506 in case I kill (cut or copy) something else inside Emacs before
 507 yanking (pasting) what I'd originally intended to.
 508
 509 #+begin_src emacs-lisp
 510 (setq save-interprogram-paste-before-kill t)
 511 #+end_src
 512
 513 *** Minibuffer
 514
 515 #+begin_src emacs-lisp
 516 (setq enable-recursive-minibuffers t
 517       resize-mini-windows t)
 518 #+end_src
 519
 520 *** Lazy-person-friendly yes/no prompts
 521
 522 Lazy people would prefer to type fewer keystrokes, especially for yes
 523 or no questions. I'm lazy.
 524
 525 #+begin_src emacs-lisp
 526 (defalias 'yes-or-no-p #'y-or-n-p)
 527 #+end_src
 528
 529 *** Startup screen and =*scratch*=
 530
 531 Firstly, let Emacs know that I'd like to have =*scratch*= as my
 532 startup buffer.
 533
 534 #+begin_src emacs-lisp
 535 (setq initial-buffer-choice t)
 536 #+end_src
 537
 538 Now let's customize the =*scratch*= buffer a bit. First off, I don't
 539 need the default hint.
 540
 541 #+begin_src emacs-lisp
 542 (setq initial-scratch-message nil)
 543 #+end_src
 544
 545 Also, let's use Text mode as the major mode, in case I want to
 546 customize it (=*scratch*='s default major mode, Fundamental mode,
 547 can't really be customized).
 548
 549 #+begin_src emacs-lisp
 550 (setq initial-major-mode 'text-mode)
 551 #+end_src
 552
 553 Inhibit the buffer list when more than 2 files are loaded.
 554
 555 #+begin_src emacs-lisp
 556 (setq inhibit-startup-buffer-menu t)
 557 #+end_src
 558
 559 I don't really need to see the startup screen or echo area message
 560 either.
 561
 562 #+begin_src emacs-lisp
 563 (advice-add #'display-startup-echo-area-message :override #'ignore)
 564 (setq inhibit-startup-screen t
 565       inhibit-startup-echo-area-message user-login-name)
 566 #+end_src
 567
 568 *** More useful frame titles
 569
 570 Show either the file name or the buffer name (in case the buffer isn't
 571 visiting a file). Borrowed from Emacs Prelude.
 572
 573 #+begin_src emacs-lisp
 574 (setq frame-title-format
 575       '("" invocation-name " - "
 576         (:eval (if (buffer-file-name)
 577                    (abbreviate-file-name (buffer-file-name))
 578                  "%b"))))
 579 #+end_src
 580
 581 *** Backups
 582
 583 Emacs' default backup settings aren't that great. Let's use more
 584 sensible options. See documentation for the ~make-backup-file~
 585 variable.
 586
 587 #+begin_src emacs-lisp
 588 (setq backup-by-copying t
 589       version-control t
 590       delete-old-versions t)
 591 #+end_src
 592
 593 *** Auto revert
 594
 595 Enable automatic reloading of changed buffers and files.
 596
 597 #+begin_src emacs-lisp
 598 (global-auto-revert-mode 1)
 599 (setq auto-revert-verbose nil
 600       global-auto-revert-non-file-buffers t)
 601 #+end_src
 602
 603 *** Always use space for indentation
 604
 605 #+begin_src emacs-lisp
 606 (setq-default
 607  indent-tabs-mode nil
 608  require-final-newline t
 609  tab-width 4)
 610 #+end_src
 611
 612 *** Winner mode
 613
 614 Enable =winner-mode=.
 615
 616 #+begin_src emacs-lisp
 617 (winner-mode 1)
 618 #+end_src
 619
 620 *** Close =*compilation*= on success
 621
 622 #+begin_src emacs-lisp
 623 (setq compilation-exit-message-function
 624       (lambda (status code msg)
 625         "Close the compilation window if successful."
 626         ;; if M-x compile exits with 0
 627          (when (and (eq status 'exit) (zerop code))
 628            (bury-buffer)
 629            (delete-window (get-buffer-window (get-buffer "*compilation*"))))
 630          ;; return the result of compilation-exit-message-function
 631          (cons msg code)))
 632 #+end_src
 633
 634 ** Bindings
 635
 636 #+begin_src emacs-lisp
 637 (bind-keys
 638  ("C-c b k" . kill-this-buffer)
 639  ("C-c s s" . save-buffer)
 640  ("C-c b s" . save-buffer)
 641  ("C-c S"   . save-buffer)
 642  ("C-c o"   . other-window)
 643  ("C-c q q" . save-buffers-kill-terminal))
 644 #+end_src
 645
 646 ** Packages
 647
 648 The packages in this section are absolutely essential to my everyday
 649 workflow, and they play key roles in how I do my computing. They
 650 immensely enhance the Emacs experience for me; both using Emacs, and
 651 customizing it.
 652
 653 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
 654
 655 #+begin_src emacs-lisp
 656 (use-package auto-compile
 657   :demand t
 658   :config
 659   (auto-compile-on-load-mode)
 660   (auto-compile-on-save-mode)
 661   (setq auto-compile-display-buffer               nil
 662         auto-compile-mode-line-counter            t
 663         auto-compile-source-recreate-deletes-dest t
 664         auto-compile-toggle-deletes-nonlib-dest   t
 665         auto-compile-update-autoloads             t)
 666   (add-hook 'auto-compile-inhibit-compile-hook
 667             'auto-compile-inhibit-compile-detached-git-head))
 668 #+end_src
 669
 670 *** [[https://orgmode.org/][Org mode]]
 671
 672 #+begin_quote
 673 Org mode is for keeping notes, maintaining TODO lists, planning
 674 projects, and authoring documents with a fast and effective plain-text
 675 system.
 676 #+end_quote
 677
 678 In short, my favourite way of life.
 679
 680 #+begin_src emacs-lisp
 681 (use-package org
 682   :config
 683   (setq org-src-tab-acts-natively t
 684         org-src-preserve-indentation nil
 685         org-edit-src-content-indentation 0
 686         org-log-done 'time)
 687   :hook (org-mode . org-indent-mode))
 688
 689 (use-package org-notmuch
 690   :after (:any org notmuch))
 691 #+end_src
 692
 693 **** asynchronous tangle
 694
 695 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
 696 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
 697 file.
 698
 699 #+begin_src emacs-lisp
 700 (after! org
 701   (defvar amin-show-async-tangle-results nil
 702     "Keep *emacs* async buffers around for later inspection.")
 703
 704   (defvar amin-show-async-tangle-time nil
 705     "Show the time spent tangling the file.")
 706
 707   (defvar amin-async-tangle-post-compile "make ti"
 708     "If non-nil, pass to `compile' after successful tangle.")
 709
 710   (defun amin/async-babel-tangle ()
 711     "Tangle org file asynchronously."
 712     (interactive)
 713     (let* ((file-tangle-start-time (current-time))
 714            (file (buffer-file-name))
 715            (file-nodir (file-name-nondirectory file))
 716            (async-quiet-switch "-q"))
 717       (async-start
 718        `(lambda ()
 719           (require 'org)
 720           (org-babel-tangle-file ,file))
 721        (unless amin-show-async-tangle-results
 722          `(lambda (result)
 723             (if result
 724                 (progn
 725                   (message "Tangled %s%s"
 726                            ,file-nodir
 727                            (if amin-show-async-tangle-time
 728                                (format " (%.3fs)"
 729                                        (float-time (time-subtract (current-time)
 730                                                                   ',file-tangle-start-time)))
 731                              ""))
 732                   (when amin-async-tangle-post-compile
 733                     (compile amin-async-tangle-post-compile)))
 734               (message "Tangling %s failed" ,file-nodir))))))))
 735
 736 (add-to-list
 737  'safe-local-variable-values
 738  '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
 739 #+end_src
 740
 741 *** [[https://magit.vc/][Magit]]
 742
 743 #+begin_quote
 744 It's Magit! A Git porcelain inside Emacs.
 745 #+end_quote
 746
 747 Not just how I do git, but /the/ way to do git.
 748
 749 #+begin_src emacs-lisp
 750 (use-package magit
 751   :defer t
 752   :bind
 753   (("s-g"   . magit-dispatch-popup)
 754    ("C-x g" . magit-status)
 755    :prefix-map amin--magit-prefix-map
 756    :prefix "C-c g"
 757    ("SPC" . magit-status)
 758    ("s"   . magit-status)
 759    ("S"   . magit-status-prefix)
 760    ("B"   . magit-blame)
 761    ("C"   . magit-clone)
 762    ("f"   . magit-fetch)
 763    ("F"   . magit-pull)
 764    ("P"   . magit-push)
 765    ("p"   . magit-dispatch-popup)
 766    ("c c" . magit-commit)
 767    ("c a" . magit-commit-amend)
 768    ("b b" . magit-checkout)
 769    ("b c" . magit-branch))
 770   :config
 771   (magit-add-section-hook 'magit-status-sections-hook
 772                           'magit-insert-modules
 773                           'magit-insert-stashes
 774                           'append))
 775 #+end_src
 776
 777 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
 778
 779 #+begin_quote
 780 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
 781 an overview, and more. Oh, man!
 782 #+end_quote
 783
 784 There's no way I could top that, so I won't attempt to.
 785
 786 **** Ivy
 787
 788 #+begin_src emacs-lisp
 789 (use-package ivy
 790   :defer 1
 791   :bind
 792   (("C-c b b" . ivy-switch-buffer)
 793    :map ivy-minibuffer-map
 794    ([escape] . keyboard-escape-quit)
 795    ([S-up]   . ivy-previous-history-element)
 796    ([S-down] . ivy-next-history-element)
 797    ("DEL"    . ivy-backward-delete-char))
 798   :config
 799   (setq ivy-wrap t)
 800   (ivy-mode 1))
 801 #+end_src
 802
 803 **** Swiper
 804
 805 #+begin_src emacs-lisp
 806 (use-package swiper
 807   :bind (([remap isearch-forward]  . swiper)
 808          ([remap isearch-backward] . swiper)))
 809 #+end_src
 810
 811 **** Counsel
 812
 813 #+begin_src emacs-lisp
 814 (use-package counsel
 815   :defer 1
 816   :bind (([remap execute-extended-command] . counsel-M-x)
 817          ([remap find-file]                . counsel-find-file)
 818          ("s-r"                            . counsel-recentf)
 819          ("C-c x"                          . counsel-M-x)
 820          ("C-c f ."                        . counsel-find-file)
 821          ("C-c f r"                        . counsel-recentf)
 822          :map minibuffer-local-map
 823          ("C-r" . counsel-minibuffer-history))
 824   :config
 825   (counsel-mode 1)
 826   (defalias 'locate #'counsel-locate))
 827 #+end_src
 828
 829 *** eshell
 830
 831 #+begin_src emacs-lisp
 832 (use-package eshell
 833   :commands eshell
 834   :config
 835   (eval-when-compile (defvar eshell-prompt-regexp))
 836   (defun amin/eshell-quit-or-delete-char (arg)
 837     (interactive "p")
 838     (if (and (eolp) (looking-back eshell-prompt-regexp nil))
 839         (eshell-life-is-too-much)
 840       (delete-char arg)))
 841
 842   (defun amin/eshell-clear ()
 843     (interactive)
 844     (let ((inhibit-read-only t))
 845       (erase-buffer))
 846     (eshell-send-input))
 847
 848   (defun amin|eshell-setup ()
 849     (bind-keys :map eshell-mode-map
 850                ("C-d" . amin/eshell-quit-or-delete-char)
 851                ("C-l" . amin/eshell-clear)))
 852
 853   :hook (eshell-mode . amin|eshell-setup))
 854 #+end_src
 855
 856 *** Ibuffer
 857
 858 #+begin_src emacs-lisp
 859 (use-package ibuffer
 860   :bind
 861   (("C-x C-b" . ibuffer-other-window)
 862    ("C-c b B" . ibuffer-other-window)
 863    :map ibuffer-mode-map
 864    ("P"   . ibuffer-backward-filter-group)
 865    ("N"   . ibuffer-forward-filter-group)
 866    ("M-p" . ibuffer-do-print)
 867    ("M-n" . ibuffer-do-shell-command-pipe-replace))
 868   :config
 869   ;; Use human readable Size column instead of original one
 870   (define-ibuffer-column size-h
 871     (:name "Size" :inline t)
 872     (cond
 873      ((> (buffer-size) 1000000) (format "%7.1fM" (/ (buffer-size) 1000000.0)))
 874      ((> (buffer-size) 100000) (format "%7.0fk" (/ (buffer-size) 1000.0)))
 875      ((> (buffer-size) 1000) (format "%7.1fk" (/ (buffer-size) 1000.0)))
 876      (t (format "%8d" (buffer-size)))))
 877   :custom
 878   (ibuffer-saved-filter-groups
 879    '(("default"
 880       ("dired" (mode . dired-mode))
 881       ("org"   (name . "^.*org$"))
 882       ("web"
 883        (or
 884         (mode . web-mode)
 885         (mode . js2-mode)))
 886       ("shell"
 887        (or
 888         (mode . eshell-mode)
 889         (mode . shell-mode)))
 890       ("notmuch" (name . "\*notmuch\*"))
 891       ("programming"
 892        (or
 893         (mode . python-mode)
 894         (mode . c++-mode)
 895         (mode . emacs-lisp-mode)))
 896       ("emacs"
 897        (or
 898         (name . "^\\*scratch\\*$")
 899         (name . "^\\*Messages\\*$"))))))
 900   (ibuffer-formats
 901    '((mark modified read-only locked " "
 902            (name 18 18 :left :elide)
 903            " "
 904            (size-h 9 -1 :right)
 905            " "
 906            (mode 16 16 :left :elide)
 907            " " filename-and-process)
 908      (mark " "
 909            (name 16 -1)
 910            " " filename)))
 911   :hook (ibuffer . (lambda () (ibuffer-switch-to-saved-filter-groups "default"))))
 912 #+end_src
 913
 914 * Borg's =layer/essentials=
 915
 916 TODO: break this giant source block down into individual org sections.
 917
 918 #+begin_src emacs-lisp
 919 (use-package dash
 920   :config (dash-enable-font-lock))
 921
 922 (use-package diff-hl
 923   :config
 924   (setq diff-hl-draw-borders nil)
 925   (global-diff-hl-mode)
 926   (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
 927
 928 (use-package dired
 929   :defer t
 930   :config (setq dired-listing-switches "-alh"))
 931
 932 (use-package eldoc
 933   :when (version< "25" emacs-version)
 934   :config (global-eldoc-mode))
 935
 936 (use-package help
 937   :defer t
 938   :config (temp-buffer-resize-mode))
 939
 940 (progn ;    `isearch'
 941   (setq isearch-allow-scroll t))
 942
 943 (use-package lisp-mode
 944   :config
 945   (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
 946   (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
 947   (defun indent-spaces-mode ()
 948     (setq indent-tabs-mode nil))
 949   (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
 950
 951 (use-package man
 952   :defer t
 953   :config (setq Man-width 80))
 954
 955 (use-package paren
 956   :config (show-paren-mode))
 957
 958 (use-package prog-mode
 959   :config (global-prettify-symbols-mode)
 960   (defun indicate-buffer-boundaries-left ()
 961     (setq indicate-buffer-boundaries 'left))
 962   (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
 963
 964 (use-package recentf
 965   :demand t
 966   :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
 967
 968 (use-package savehist
 969   :config (savehist-mode))
 970
 971 (use-package saveplace
 972   :when (version< "25" emacs-version)
 973   :config (save-place-mode))
 974
 975 (use-package simple
 976   :config (column-number-mode))
 977
 978 (progn ;    `text-mode'
 979   (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
 980
 981 (use-package tramp
 982   :defer t
 983   :config
 984   (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
 985   (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
 986   (add-to-list 'tramp-default-proxies-alist
 987                (list (regexp-quote (system-name)) nil nil)))
 988
 989 (use-package undo-tree
 990   :bind (("C-?" . undo-tree-undo)
 991          ("M-_" . undo-tree-redo))
 992   :config
 993   (global-undo-tree-mode)
 994   (setq undo-tree-mode-lighter ""
 995         undo-tree-auto-save-history t))
 996 #+end_src
 997
 998 * Editing
 999
1000 ** Company
1001
1002 #+begin_src emacs-lisp
1003 (use-package company
1004   :defer 5
1005   :bind
1006   (:map company-active-map
1007         ([tab] . company-complete-common-or-cycle))
1008   :custom
1009   (company-idle-delay 0.3)
1010   (company-minimum-prefix-length 1)
1011   (company-selection-wrap-around t)
1012   (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
1013   :config
1014   (global-company-mode t))
1015 #+end_src
1016
1017 * Syntax and spell checking
1018 #+begin_src emacs-lisp
1019 (use-package flycheck
1020   :hook (prog-mode . flycheck-mode)
1021   :config
1022   ;; Use the load-path from running Emacs when checking elisp files
1023   (setq flycheck-emacs-lisp-load-path 'inherit)
1024
1025   ;; Only flycheck when I actually save the buffer
1026   (setq flycheck-check-syntax-automatically '(mode-enabled save)))
1027 #+end_src
1028 * Programming modes
1029
1030 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
1031
1032 #+begin_src emacs-lisp
1033 (use-package alloy-mode
1034   :config (setq alloy-basic-offset 2))
1035 #+end_src
1036
1037 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
1038
1039 #+begin_src emacs-lisp
1040 (use-package proof-site  ; Proof General
1041   :load-path "lib/proof-site/generic/")
1042 #+end_src
1043
1044 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
1045
1046 #+begin_src emacs-lisp
1047 (eval-when-compile (defvar lean-mode-map))
1048 (use-package lean-mode
1049   :bind (:map lean-mode-map
1050               ("S-SPC" . company-complete)))
1051 #+end_src
1052
1053 ** Haskell
1054
1055 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
1056
1057 #+begin_src emacs-lisp
1058 (use-package haskell-mode
1059   :config
1060   (setq haskell-indentation-layout-offset 4
1061         haskell-indentation-left-offset 4
1062         flycheck-checker 'haskell-hlint
1063         flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
1064 #+end_src
1065
1066 *** [[https://github.com/jyp/dante][dante]]
1067
1068 #+begin_src emacs-lisp
1069 (use-package dante
1070   :after haskell-mode
1071   :commands dante-mode
1072   :hook (haskell-mode . dante-mode))
1073 #+end_src
1074
1075 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1076
1077 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1078 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1079
1080 #+begin_src emacs-lisp
1081 (use-package hlint-refactor
1082   :bind (:map hlint-refactor-mode-map
1083               ("C-c l b" . hlint-refactor-refactor-buffer)
1084               ("C-c l r" . hlint-refactor-refactor-at-point))
1085   :hook (haskell-mode . hlint-refactor-mode))
1086 #+end_src
1087
1088 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1089
1090 #+begin_src emacs-lisp
1091 (use-package flycheck-haskell)
1092 #+end_src
1093
1094 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1095 :PROPERTIES:
1096 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1097 :END:
1098
1099 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1100 instead.
1101
1102 #+begin_src emacs-lisp :tangle no
1103 ;;; hs-lint.el --- minor mode for HLint code checking
1104
1105 ;; Copyright 2009 (C) Alex Ott
1106 ;;
1107 ;; Author: Alex Ott <alexott@gmail.com>
1108 ;; Keywords: haskell, lint, HLint
1109 ;; Requirements:
1110 ;; Status: distributed under terms of GPL2 or above
1111
1112 ;; Typical message from HLint looks like:
1113 ;;
1114 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1115 ;; Found:
1116 ;;   count1 p l = length (filter p l)
1117 ;; Why not:
1118 ;;   count1 p = length . filter p
1119
1120
1121 (require 'compile)
1122
1123 (defgroup hs-lint nil
1124   "Run HLint as inferior of Emacs, parse error messages."
1125   :group 'tools
1126   :group 'haskell)
1127
1128 (defcustom hs-lint-command "hlint"
1129   "The default hs-lint command for \\[hlint]."
1130   :type 'string
1131   :group 'hs-lint)
1132
1133 (defcustom hs-lint-save-files t
1134   "Save modified files when run HLint or no (ask user)"
1135   :type 'boolean
1136   :group 'hs-lint)
1137
1138 (defcustom hs-lint-replace-with-suggestions nil
1139   "Replace user's code with suggested replacements"
1140   :type 'boolean
1141   :group 'hs-lint)
1142
1143 (defcustom hs-lint-replace-without-ask nil
1144   "Replace user's code with suggested replacements automatically"
1145   :type 'boolean
1146   :group 'hs-lint)
1147
1148 (defun hs-lint-process-setup ()
1149   "Setup compilation variables and buffer for `hlint'."
1150   (run-hooks 'hs-lint-setup-hook))
1151
1152 ;; regex for replace suggestions
1153 ;;
1154 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1155 ;; Found:
1156 ;; \s +\(.*\)
1157 ;; Why not:
1158 ;; \s +\(.*\)
1159
1160 (defvar hs-lint-regex
1161   "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1162   "Regex for HLint messages")
1163
1164 (defun make-short-string (str maxlen)
1165   (if (< (length str) maxlen)
1166       str
1167     (concat (substring str 0 (- maxlen 3)) "...")))
1168
1169 (defun hs-lint-replace-suggestions ()
1170   "Perform actual replacement of suggestions"
1171   (goto-char (point-min))
1172   (while (re-search-forward hs-lint-regex nil t)
1173     (let* ((fname (match-string 1))
1174           (fline (string-to-number (match-string 2)))
1175           (old-code (match-string 4))
1176           (new-code (match-string 5))
1177           (msg (concat "Replace '" (make-short-string old-code 30)
1178                        "' with '" (make-short-string new-code 30) "'"))
1179           (bline 0)
1180           (eline 0)
1181           (spos 0)
1182           (new-old-code ""))
1183       (save-excursion
1184         (switch-to-buffer (get-file-buffer fname))
1185         (goto-char (point-min))
1186         (forward-line (1- fline))
1187         (beginning-of-line)
1188         (setf bline (point))
1189         (when (or hs-lint-replace-without-ask
1190                   (yes-or-no-p msg))
1191           (end-of-line)
1192           (setf eline (point))
1193           (beginning-of-line)
1194           (setf old-code (regexp-quote old-code))
1195           (while (string-match "\\\\ " old-code spos)
1196             (setf new-old-code (concat new-old-code
1197                                  (substring old-code spos (match-beginning 0))
1198                                  "\\ *"))
1199             (setf spos (match-end 0)))
1200           (setf new-old-code (concat new-old-code (substring old-code spos)))
1201           (remove-text-properties bline eline '(composition nil))
1202           (when (re-search-forward new-old-code eline t)
1203             (replace-match new-code nil t)))))))
1204
1205 (defun hs-lint-finish-hook (buf msg)
1206   "Function, that is executed at the end of HLint execution"
1207   (if hs-lint-replace-with-suggestions
1208       (hs-lint-replace-suggestions)
1209       (next-error 1 t)))
1210
1211 (define-compilation-mode hs-lint-mode "HLint"
1212   "Mode for check Haskell source code."
1213   (set (make-local-variable 'compilation-process-setup-function)
1214        'hs-lint-process-setup)
1215   (set (make-local-variable 'compilation-disable-input) t)
1216   (set (make-local-variable 'compilation-scroll-output) nil)
1217   (set (make-local-variable 'compilation-finish-functions)
1218        (list 'hs-lint-finish-hook))
1219   )
1220
1221 (defun hs-lint ()
1222   "Run HLint for current buffer with haskell source"
1223   (interactive)
1224   (save-some-buffers hs-lint-save-files)
1225   (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1226                      'hs-lint-mode))
1227
1228 (provide 'hs-lint)
1229 ;;; hs-lint.el ends here
1230 #+end_src
1231
1232 #+begin_src emacs-lisp :tangle no
1233 (use-package hs-lint
1234   :load-path "lisp/"
1235   :bind (:map haskell-mode-map
1236               ("C-c l l" . hs-lint)))
1237 #+end_src
1238
1239 ** Web dev
1240
1241 *** SGML and HTML
1242
1243 #+begin_src emacs-lisp
1244 (use-package sgml-mode
1245   :config
1246   (setq sgml-basic-offset 2))
1247 #+end_src
1248
1249 *** CSS and SCSS
1250
1251 #+begin_src emacs-lisp
1252 (use-package css-mode
1253   :config
1254   (setq css-indent-offset 2))
1255 #+end_src
1256
1257 *** Web mode
1258
1259 #+begin_src emacs-lisp
1260 (use-package web-mode
1261   :mode "\\.html\\'"
1262   :config
1263   (setq-every! 2
1264     web-mode-code-indent-offset
1265     web-mode-css-indent-offset
1266     web-mode-markup-indent-offset))
1267 #+end_src
1268
1269 *** Emmet mode
1270
1271 #+begin_src emacs-lisp
1272 (use-package emmet-mode
1273   :bind* (("C-)" . emmet-next-edit-point)
1274           ("C-(" . emmet-prev-edit-point))
1275   :init
1276   (setq emmet-move-cursor-between-quotes t)
1277   :hook (web-mode css-mode html-mode sgml-mode))
1278 #+end_src
1279
1280 * Emacs Enhancements
1281
1282 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1283
1284 #+begin_quote
1285 Emacs package that displays available keybindings in popup
1286 #+end_quote
1287
1288 #+begin_src emacs-lisp
1289 (use-package which-key
1290   :defer 1
1291   :config (which-key-mode))
1292 #+end_src
1293
1294 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1295
1296 #+begin_src emacs-lisp
1297 (use-package doom-modeline
1298   :demand t
1299   :config (setq doom-modeline-height 32)
1300   :hook (after-init . doom-modeline-init))
1301 #+end_src
1302
1303 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1304
1305 #+begin_src emacs-lisp :tangle no
1306 (use-package tao-theme
1307   :demand t
1308   :config (load-theme 'tao-yang t))
1309 #+end_src
1310
1311 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1312
1313 #+begin_src emacs-lisp
1314 (load-theme 'eink t)
1315 #+end_src
1316
1317 ** [[https://github.com/bbatsov/crux][crux]]
1318
1319 #+begin_src emacs-lisp
1320 (use-package crux
1321   :bind (("C-c d"   . crux-duplicate-current-line-or-region)
1322          ("C-c M-d" . crux-duplicate-and-comment-current-line-or-region)
1323          ("C-c b K" . crux-kill-other-buffers)
1324          ("C-c f c" . crux-copy-file-preserve-attributes)
1325          ("C-c f D" . crux-delete-file-and-buffer)
1326          ("C-c f R" . crux-rename-file-and-buffer)
1327          ("C-S-j"   . crux-top-join-line)
1328          ("C-c j"   . crux-top-join-line)))
1329 #+end_src
1330
1331 ** [[https://github.com/alezost/mwim.el][mwim]]
1332
1333 #+begin_src emacs-lisp
1334 (use-package mwim
1335   :bind (("C-a"    . mwim-beginning-of-code-or-line)
1336          ("C-e"    . mwim-end-of-code-or-line)
1337          ("<home>" . mwim-beginning-of-line-or-code)
1338          ("<end>"  . mwim-end-of-line-or-code)))
1339 #+end_src
1340
1341 ** projectile
1342
1343 #+begin_src emacs-lisp
1344 (use-package projectile
1345   :defer 5
1346   :bind-keymap ("C-c p" . projectile-command-map)
1347   :config
1348   (projectile-mode)
1349
1350   (defun my-projectile-invalidate-cache (&rest _args)
1351     ;; ignore the args to `magit-checkout'
1352     (projectile-invalidate-cache nil))
1353
1354   (eval-after-load 'magit-branch
1355     '(progn
1356        (advice-add 'magit-checkout
1357                    :after #'my-projectile-invalidate-cache)
1358        (advice-add 'magit-branch-and-checkout
1359                    :after #'my-projectile-invalidate-cache))))
1360 #+end_src
1361
1362 ** [[https://github.com/Wilfred/helpful][helpful]]
1363
1364 #+begin_src emacs-lisp
1365 (use-package helpful
1366   :bind
1367   (("C-h f"   . helpful-callable)
1368    ("C-h v"   . helpful-variable)
1369    ("C-h k"   . helpful-key)
1370    ("C-c C-d" . helpful-at-point)
1371    ("C-h F"   . helpful-function)
1372    ("C-h C"   . helpful-command)))
1373 #+end_src
1374
1375 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1376
1377 #+begin_src emacs-lisp
1378 (use-package shell-pop
1379   :custom
1380   (shell-pop-universal-key "C-c e")
1381   (shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1382 #+end_src
1383
1384 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1385
1386 Make =*scratch*= and =*Messages*= unkillable.
1387
1388 #+begin_src emacs-lisp
1389 (use-package unkillable-scratch
1390   :config
1391   (unkillable-scratch 1)
1392   :custom
1393   (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1394 #+end_src
1395
1396 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1397
1398 #+begin_example
1399 ,----
1400 | make pretty boxed quotes like this
1401 `----
1402 #+end_example
1403
1404 #+begin_src emacs-lisp
1405 (use-package boxquote
1406   :bind
1407   (:prefix-map amin--boxquote-prefix-map
1408    :prefix "C-c q"
1409    ("b"   . boxquote-buffer)
1410    ("B"   . boxquote-insert-buffer)
1411    ("d"   . boxquote-defun)
1412    ("F"   . boxquote-insert-file)
1413    ("hf"  . boxquote-describe-function)
1414    ("hk"  . boxquote-describe-key)
1415    ("hv"  . boxquote-describe-variable)
1416    ("hw"  . boxquote-where-is)
1417    ("k"   . boxquote-kill)
1418    ("p"   . boxquote-paragraph)
1419    ("q"   . boxquote-boxquote)
1420    ("r"   . boxquote-region)
1421    ("s"   . boxquote-shell-command)
1422    ("t"   . boxquote-text)
1423    ("T"   . boxquote-title)
1424    ("u"   . boxquote-unbox)
1425    ("U"   . boxquote-unbox-region)
1426    ("y"   . boxquote-yank)
1427    ("M-q" . boxquote-fill-paragraph)
1428    ("M-w" . boxquote-kill-ring-save)))
1429 #+end_src
1430
1431 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1432
1433 ** [[https://github.com/DarthFennec/highlight-indent-guides][highlight-indent-guides]]
1434
1435 #+begin_src emacs-lisp
1436 (use-package highlight-indent-guides
1437   :demand t
1438   :hook ((prog-mode . highlight-indent-guides-mode)
1439          (org-mode  . highlight-indent-guides-mode))
1440   :config
1441   (setq highlight-indent-guides-character ?\|)
1442   (setq highlight-indent-guides-auto-enabled nil)
1443   (setq highlight-indent-guides-method 'character)
1444   (setq highlight-indent-guides-responsive 'top)
1445   (set-face-foreground 'highlight-indent-guides-character-face "gainsboro")
1446   (set-face-foreground 'highlight-indent-guides-top-character-face "grey40")) ; grey13 is nice too
1447 #+end_src
1448
1449 * Email
1450 ** [[https://notmuchmail.org][notmuch]]
1451
1452 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1453
1454 #+begin_src emacs-lisp
1455 (defvar amin-maildir "~/mail")
1456
1457 (use-package sendmail
1458   ;; :ensure nil
1459   :config
1460   (setq sendmail-program "/usr/bin/msmtp"
1461         ; message-sendmail-extra-arguments '("-v" "-d")
1462         mail-specify-envelope-from t
1463         mail-envelope-from 'header))
1464
1465 (use-package message
1466   ;; :ensure nil
1467   :config
1468   (setq message-kill-buffer-on-exit t
1469         message-send-mail-function 'message-send-mail-with-sendmail
1470         message-sendmail-envelope-from 'header
1471         message-directory "drafts"
1472         message-user-fqdn "aminb.org")
1473   (add-hook 'message-mode-hook
1474             (lambda () (setq fill-column 65
1475                         message-fill-column 65)))
1476   (add-hook 'message-mode-hook
1477             #'flyspell-mode)
1478   ;; (add-hook 'notmuch-message-mode-hook #'+doom-modeline|set-special-modeline)
1479   ;; TODO: is there a way to only run this when replying and not composing?
1480   ;; (add-hook 'notmuch-message-mode-hook
1481   ;;           (lambda () (progn
1482   ;;                   (newline)
1483   ;;                   (newline)
1484   ;;                   (forward-line -1)
1485   ;;                   (forward-line -1))))
1486   ;; (add-hook 'message-setup-hook
1487   ;;           #'mml-secure-message-sign-pgpmime)
1488   )
1489
1490 (after! mml-sec
1491   (setq mml-secure-openpgp-encrypt-to-self t
1492         mml-secure-openpgp-sign-with-sender t))
1493
1494 (defun amin/notmuch ()
1495   "Delete other windows, then launch `notmuch'."
1496   (interactive)
1497   (delete-other-windows)
1498   (notmuch))
1499
1500 (use-package notmuch
1501   :commands notmuch
1502   :bind ("C-c m" . amin/notmuch)
1503   :custom (notmuch-always-prompt-for-sender t)
1504   :config
1505   (setq notmuch-hello-sections
1506         '(notmuch-hello-insert-header
1507           notmuch-hello-insert-saved-searches
1508           ;; notmuch-hello-insert-search
1509           notmuch-hello-insert-alltags)
1510         notmuch-search-oldest-first nil
1511         notmuch-show-all-tags-list t
1512         notmuch-message-headers  ; see bug follow-up above
1513         '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1514         notmuch-hello-thousands-separator ","
1515         notmuch-fcc-dirs
1516         '(("amin@aminb.org"        . "amin/Sent")
1517           ("amin@gnu.org"          . "gnu/Sent")
1518           ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1519           ("mab@gnu.org"           . "gnu/Sent")
1520           ("aminb@gnu.org"         . "gnu/Sent")
1521           (".*"                    . "sent"))
1522         notmuch-search-result-format
1523         '(("date"    . "%12s ")
1524           ("count"   . "%-7s ")
1525           ("authors" . "%-40s ")
1526           ("subject" . "%s ")
1527           ("tags"    . "(%s)"))
1528         notmuch-saved-searches
1529         '((:name "inbox"     :query "tag:inbox"     :key "i")
1530           (:name "unread"    :query "tag:unread"    :key "u")
1531           (:name "latest"    :query "tag:latest"    :key "l")
1532           (:name "encrypted" :query "tag:encrypted" :key "e")
1533           (:name "flagged"   :query "tag:flagged"   :key "f")
1534           (:name "sent"      :query "tag:sent"      :key "s")
1535           (:name "drafts"    :query "tag:draft"     :key "d")
1536           (:name "all mail"  :query "*"             :key "a")))
1537   ;; (add-hook 'visual-fill-column-mode-hook
1538   ;;           (lambda ()
1539   ;;             (when (string= major-mode 'notmuch-message-mode)
1540   ;;               (setq visual-fill-column-width 70))))
1541   ;; (set! :evil-state 'notmuch-message-mode 'insert)
1542   ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1543   ;;             :override #'kill-this-buffer)
1544   :bind
1545   (:map notmuch-hello-mode-map
1546         ("u" . (lambda ()
1547                  "Search for `unread'-tagged messages"
1548                  (interactive)
1549                  (notmuch-hello-search "tag:unread")))
1550         ("i" . (lambda ()
1551                  "Search for `inbox'-tagged messages"
1552                  (interactive)
1553                  (notmuch-hello-search "tag:inbox")))
1554         ("l" . (lambda ()
1555                  "Search for `latest'-tagged messages"
1556                  (interactive)
1557                  (notmuch-hello-search "tag:latest")))
1558         ("e" . (lambda ()
1559                  "Search for `encrypted'-tagged messages"
1560                  (interactive)
1561                  (notmuch-hello-search "tag:encrypted"))))
1562   (:map notmuch-search-mode-map
1563         ("k" . (lambda ()
1564                  "Mark message read"
1565                  (interactive)
1566                  (notmuch-search-tag '("-unread"))
1567                  ;; (notmuch-search-archive-thread)
1568                  (notmuch-search-next-thread)))
1569         ("u" . (lambda ()
1570                  "Mark message unread"
1571                  (interactive)
1572                  (notmuch-search-tag '("+unread"))
1573                  (notmuch-search-next-thread)))
1574         ("K" . (lambda ()
1575                  "Mark message deleted"
1576                  (interactive)
1577                  (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1578                  (notmuch-search-next-thread)))
1579         ("S" . (lambda ()
1580                  "Mark message as spam"
1581                  (interactive)
1582                  (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1583                  (notmuch-search-next-thread))))
1584   (:map notmuch-tree-mode-map
1585         ("k" . (lambda ()
1586                  "Mark message read"
1587                  (interactive)
1588                  (notmuch-tree-tag '("-unread"))
1589                  ;; (notmuch-tree-archive-thread)
1590                  (notmuch-tree-next-message)))
1591         ("u" . (lambda ()
1592                  "Mark message unread"
1593                  (interactive)
1594                  (notmuch-tree-tag '("+unread"))
1595                  (notmuch-tree-next-message)))
1596         ("K" . (lambda ()
1597                  "Mark message deleted"
1598                  (interactive)
1599                  (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
1600                  (notmuch-tree-next-message)))
1601         ("S" . (lambda ()
1602                  "Mark message as spam"
1603                  (interactive)
1604                  (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1605                  (notmuch-tree-next-message)))))
1606
1607 (use-package counsel-notmuch
1608   :bind ("C-c s m" . counsel-notmuch))
1609
1610 (after! notmuch-crypto
1611   (setq notmuch-crypto-process-mime t))
1612
1613 (after! recentf
1614   (add-to-list 'recentf-exclude (expand-file-name amin-maildir)))
1615 #+end_src
1616
1617 ** supercite
1618
1619 #+begin_src emacs-lisp :tangle no
1620 (use-package supercite
1621   :commands sc-cite-original
1622   :init
1623   (add-hook 'mail-citation-hook 'sc-cite-original)
1624
1625   (defun sc-remove-existing-signature ()
1626     (save-excursion
1627       (goto-char (region-beginning))
1628       (when (re-search-forward message-signature-separator (region-end) t)
1629         (delete-region (match-beginning 0) (region-end)))))
1630
1631   (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1632
1633   (defun sc-remove-if-not-mailing-list ()
1634     (unless (assoc "list-id" sc-mail-info)
1635       (setq attribution sc-default-attribution
1636             citation (concat sc-citation-delimiter
1637                              sc-citation-separator))))
1638
1639   (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1640
1641   :config
1642   (defun sc-fill-if-different (&optional prefix)
1643     "Fill the region bounded by `sc-fill-begin' and point.
1644 Only fill if optional PREFIX is different than
1645 `sc-fill-line-prefix'.  If `sc-auto-fill-region-p' is nil, do not
1646 fill region.  If PREFIX is not supplied, initialize fill
1647 variables.  This is useful for a regi `begin' frame-entry."
1648     (if (not prefix)
1649         (setq sc-fill-line-prefix ""
1650               sc-fill-begin (line-beginning-position))
1651       (if (and sc-auto-fill-region-p
1652                (not (string= prefix sc-fill-line-prefix)))
1653           (let ((fill-prefix sc-fill-line-prefix))
1654             (unless (or (string= fill-prefix "")
1655                         (save-excursion
1656                           (goto-char sc-fill-begin)
1657                           (or (looking-at ">+  +")
1658                               (< (length
1659                                   (buffer-substring (point)
1660                                                     (line-end-position)))
1661                                  65))))
1662               (fill-region sc-fill-begin (line-beginning-position)))
1663             (setq sc-fill-line-prefix prefix
1664                   sc-fill-begin (line-beginning-position)))))
1665 nil))
1666 #+end_src
1667
1668 * Blogging
1669 ** [[https://ox-hugo.scripter.co][ox-hugo]]
1670
1671 #+begin_src emacs-lisp
1672 (use-package ox-hugo
1673   :after ox)
1674 #+end_src
1675
1676 * Post initialization
1677 :PROPERTIES:
1678 :CUSTOM_ID: post-initialization
1679 :END:
1680
1681 Display how long it took to load the init file.
1682
1683 #+begin_src emacs-lisp
1684 (message "Loading %s...done (%.3fs)" user-init-file
1685          (float-time (time-subtract (current-time)
1686                                     amin--before-user-init-time)))
1687 #+end_src
1688
1689 * Footer
1690 :PROPERTIES:
1691 :CUSTOM_ID: footer
1692 :END:
1693
1694 #+begin_src emacs-lisp :comments none
1695 ;;; init.el ends here
1696 #+end_src
1697
1698 * COMMENT Local Variables                                           :ARCHIVE:
1699 # Local Variables:
1700 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)
1701 # End: