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   :hook (org-mode . org-indent-mode))
 687
 688 (use-package org-notmuch
 689   :after (:any org notmuch))
 690 #+end_src
 691
 692 **** asynchronous tangle
 693
 694 =amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's
 695 d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org
 696 file.
 697
 698 #+begin_src emacs-lisp
 699 (after! org
 700   (defvar amin-show-async-tangle-results nil
 701     "Keep *emacs* async buffers around for later inspection.")
 702
 703   (defvar amin-show-async-tangle-time nil
 704     "Show the time spent tangling the file.")
 705
 706   (defvar amin-async-tangle-post-compile "make ti"
 707     "If non-nil, pass to `compile' after successful tangle.")
 708
 709   (defun amin/async-babel-tangle ()
 710     "Tangle org file asynchronously."
 711     (interactive)
 712     (let* ((file-tangle-start-time (current-time))
 713            (file (buffer-file-name))
 714            (file-nodir (file-name-nondirectory file))
 715            (async-quiet-switch "-q"))
 716       (async-start
 717        `(lambda ()
 718           (require 'org)
 719           (org-babel-tangle-file ,file))
 720        (unless amin-show-async-tangle-results
 721          `(lambda (result)
 722             (if result
 723                 (progn
 724                   (message "Tangled %s%s"
 725                            ,file-nodir
 726                            (if amin-show-async-tangle-time
 727                                (format " (%.3fs)"
 728                                        (float-time (time-subtract (current-time)
 729                                                                   ',file-tangle-start-time)))
 730                              ""))
 731                   (when amin-async-tangle-post-compile
 732                     (compile amin-async-tangle-post-compile)))
 733               (message "Tangling %s failed" ,file-nodir))))))))
 734
 735 (add-to-list
 736  'safe-local-variable-values
 737  '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))
 738 #+end_src
 739
 740 *** [[https://magit.vc/][Magit]]
 741
 742 #+begin_quote
 743 It's Magit! A Git porcelain inside Emacs.
 744 #+end_quote
 745
 746 Not just how I do git, but /the/ way to do git.
 747
 748 #+begin_src emacs-lisp
 749 (use-package magit
 750   :defer t
 751   :bind
 752   (("s-g"   . magit-dispatch-popup)
 753    ("C-x g" . magit-status)
 754    :prefix-map amin--magit-prefix-map
 755    :prefix "C-c g"
 756    ("SPC" . magit-status)
 757    ("s"   . magit-status)
 758    ("S"   . magit-status-prefix)
 759    ("B"   . magit-blame)
 760    ("C"   . magit-clone)
 761    ("f"   . magit-fetch)
 762    ("F"   . magit-pull)
 763    ("P"   . magit-push)
 764    ("p"   . magit-dispatch-popup)
 765    ("c c" . magit-commit)
 766    ("c a" . magit-commit-amend)
 767    ("b b" . magit-checkout)
 768    ("b c" . magit-branch))
 769   :config
 770   (magit-add-section-hook 'magit-status-sections-hook
 771                           'magit-insert-modules
 772                           'magit-insert-stashes
 773                           'append))
 774 #+end_src
 775
 776 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
 777
 778 #+begin_quote
 779 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
 780 an overview, and more. Oh, man!
 781 #+end_quote
 782
 783 There's no way I could top that, so I won't attempt to.
 784
 785 **** Ivy
 786
 787 #+begin_src emacs-lisp
 788 (use-package ivy
 789   :defer 1
 790   :bind
 791   (("C-c b b" . ivy-switch-buffer)
 792    :map ivy-minibuffer-map
 793    ([escape] . keyboard-escape-quit)
 794    ([S-up]   . ivy-previous-history-element)
 795    ([S-down] . ivy-next-history-element)
 796    ("DEL"    . ivy-backward-delete-char))
 797   :config
 798   (setq ivy-wrap t)
 799   (ivy-mode 1))
 800 #+end_src
 801
 802 **** Swiper
 803
 804 #+begin_src emacs-lisp
 805 (use-package swiper
 806   :bind (([remap isearch-forward]  . swiper)
 807          ([remap isearch-backward] . swiper)))
 808 #+end_src
 809
 810 **** Counsel
 811
 812 #+begin_src emacs-lisp
 813 (use-package counsel
 814   :defer 1
 815   :bind (([remap execute-extended-command] . counsel-M-x)
 816          ([remap find-file]                . counsel-find-file)
 817          ("s-r"                            . counsel-recentf)
 818          ("C-c x"                          . counsel-M-x)
 819          ("C-c f ."                        . counsel-find-file)
 820          ("C-c f r"                        . counsel-recentf)
 821          :map minibuffer-local-map
 822          ("C-r" . counsel-minibuffer-history))
 823   :config
 824   (counsel-mode 1)
 825   (defalias 'locate #'counsel-locate))
 826 #+end_src
 827
 828 *** eshell
 829
 830 #+begin_src emacs-lisp
 831 (use-package eshell
 832   :commands eshell
 833   :config
 834   (eval-when-compile (defvar eshell-prompt-regexp))
 835   (defun amin/eshell-quit-or-delete-char (arg)
 836     (interactive "p")
 837     (if (and (eolp) (looking-back eshell-prompt-regexp nil))
 838         (eshell-life-is-too-much)
 839       (delete-char arg)))
 840
 841   (defun amin/eshell-clear ()
 842     (interactive)
 843     (let ((inhibit-read-only t))
 844       (erase-buffer))
 845     (eshell-send-input))
 846
 847   (defun amin|eshell-setup ()
 848     (bind-keys :map eshell-mode-map
 849                ("C-d" . amin/eshell-quit-or-delete-char)
 850                ("C-l" . amin/eshell-clear)))
 851
 852   :hook (eshell-mode . amin|eshell-setup))
 853 #+end_src
 854
 855 *** Ibuffer
 856
 857 #+begin_src emacs-lisp
 858 (use-package ibuffer
 859   :bind
 860   (("C-x C-b" . ibuffer-other-window)
 861    ("C-c b B" . ibuffer-other-window)
 862    :map ibuffer-mode-map
 863    ("P"   . ibuffer-backward-filter-group)
 864    ("N"   . ibuffer-forward-filter-group)
 865    ("M-p" . ibuffer-do-print)
 866    ("M-n" . ibuffer-do-shell-command-pipe-replace))
 867   :config
 868   ;; Use human readable Size column instead of original one
 869   (define-ibuffer-column size-h
 870     (:name "Size" :inline t)
 871     (cond
 872      ((> (buffer-size) 1000000) (format "%7.1fM" (/ (buffer-size) 1000000.0)))
 873      ((> (buffer-size) 100000) (format "%7.0fk" (/ (buffer-size) 1000.0)))
 874      ((> (buffer-size) 1000) (format "%7.1fk" (/ (buffer-size) 1000.0)))
 875      (t (format "%8d" (buffer-size)))))
 876   :custom
 877   (ibuffer-saved-filter-groups
 878    '(("default"
 879       ("dired" (mode . dired-mode))
 880       ("org"   (name . "^.*org$"))
 881       ("web"
 882        (or
 883         (mode . web-mode)
 884         (mode . js2-mode)))
 885       ("shell"
 886        (or
 887         (mode . eshell-mode)
 888         (mode . shell-mode)))
 889       ("notmuch" (name . "\*notmuch\*"))
 890       ("programming"
 891        (or
 892         (mode . python-mode)
 893         (mode . c++-mode)
 894         (mode . emacs-lisp-mode)))
 895       ("emacs"
 896        (or
 897         (name . "^\\*scratch\\*$")
 898         (name . "^\\*Messages\\*$"))))))
 899   (ibuffer-formats
 900    '((mark modified read-only locked " "
 901            (name 18 18 :left :elide)
 902            " "
 903            (size-h 9 -1 :right)
 904            " "
 905            (mode 16 16 :left :elide)
 906            " " filename-and-process)
 907      (mark " "
 908            (name 16 -1)
 909            " " filename)))
 910   :hook (ibuffer . (lambda () (ibuffer-switch-to-saved-filter-groups "default"))))
 911 #+end_src
 912
 913 * Borg's =layer/essentials=
 914
 915 TODO: break this giant source block down into individual org sections.
 916
 917 #+begin_src emacs-lisp
 918 (use-package dash
 919   :config (dash-enable-font-lock))
 920
 921 (use-package diff-hl
 922   :config
 923   (setq diff-hl-draw-borders nil)
 924   (global-diff-hl-mode)
 925   (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
 926
 927 (use-package dired
 928   :defer t
 929   :config (setq dired-listing-switches "-alh"))
 930
 931 (use-package eldoc
 932   :when (version< "25" emacs-version)
 933   :config (global-eldoc-mode))
 934
 935 (use-package help
 936   :defer t
 937   :config (temp-buffer-resize-mode))
 938
 939 (progn ;    `isearch'
 940   (setq isearch-allow-scroll t))
 941
 942 (use-package lisp-mode
 943   :config
 944   (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
 945   (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
 946   (defun indent-spaces-mode ()
 947     (setq indent-tabs-mode nil))
 948   (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
 949
 950 (use-package man
 951   :defer t
 952   :config (setq Man-width 80))
 953
 954 (use-package paren
 955   :config (show-paren-mode))
 956
 957 (use-package prog-mode
 958   :config (global-prettify-symbols-mode)
 959   (defun indicate-buffer-boundaries-left ()
 960     (setq indicate-buffer-boundaries 'left))
 961   (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
 962
 963 (use-package recentf
 964   :demand t
 965   :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
 966
 967 (use-package savehist
 968   :config (savehist-mode))
 969
 970 (use-package saveplace
 971   :when (version< "25" emacs-version)
 972   :config (save-place-mode))
 973
 974 (use-package simple
 975   :config (column-number-mode))
 976
 977 (progn ;    `text-mode'
 978   (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
 979
 980 (use-package tramp
 981   :defer t
 982   :config
 983   (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
 984   (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
 985   (add-to-list 'tramp-default-proxies-alist
 986                (list (regexp-quote (system-name)) nil nil)))
 987
 988 (use-package undo-tree
 989   :bind (("C-?" . undo-tree-undo)
 990          ("M-_" . undo-tree-redo))
 991   :config
 992   (global-undo-tree-mode)
 993   (setq undo-tree-mode-lighter ""
 994         undo-tree-auto-save-history t))
 995 #+end_src
 996
 997 * Editing
 998
 999 ** Company
1000
1001 #+begin_src emacs-lisp
1002 (use-package company
1003   :defer 5
1004   :bind
1005   (:map company-active-map
1006         ([tab] . company-complete-common-or-cycle))
1007   :custom
1008   (company-idle-delay 0.3)
1009   (company-minimum-prefix-length 1)
1010   (company-selection-wrap-around t)
1011   (company-dabbrev-char-regexp "\\sw\\|\\s_\\|[-_]")
1012   :config
1013   (global-company-mode t))
1014 #+end_src
1015
1016 * Syntax and spell checking
1017 #+begin_src emacs-lisp
1018 (use-package flycheck
1019   :hook (prog-mode . flycheck-mode)
1020   :config
1021   ;; Use the load-path from running Emacs when checking elisp files
1022   (setq flycheck-emacs-lisp-load-path 'inherit)
1023
1024   ;; Only flycheck when I actually save the buffer
1025   (setq flycheck-check-syntax-automatically '(mode-enabled save)))
1026 #+end_src
1027 * Programming modes
1028
1029 ** [[http://alloytools.org][Alloy]] (with [[https://github.com/dwwmmn/alloy-mode][alloy-mode]])
1030
1031 #+begin_src emacs-lisp
1032 (use-package alloy-mode
1033   :config (setq alloy-basic-offset 2))
1034 #+end_src
1035
1036 ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]])
1037
1038 #+begin_src emacs-lisp
1039 (use-package proof-site  ; Proof General
1040   :load-path "lib/proof-site/generic/")
1041 #+end_src
1042
1043 ** [[https://leanprover.github.io][Lean]] (with [[https://github.com/leanprover/lean-mode][lean-mode]])
1044
1045 #+begin_src emacs-lisp
1046 (eval-when-compile (defvar lean-mode-map))
1047 (use-package lean-mode
1048   :bind (:map lean-mode-map
1049               ("S-SPC" . company-complete)))
1050 #+end_src
1051
1052 ** Haskell
1053
1054 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
1055
1056 #+begin_src emacs-lisp
1057 (use-package haskell-mode
1058   :config
1059   (setq haskell-indentation-layout-offset 4
1060         haskell-indentation-left-offset 4
1061         flycheck-checker 'haskell-hlint
1062         flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
1063 #+end_src
1064
1065 *** [[https://github.com/jyp/dante][dante]]
1066
1067 #+begin_src emacs-lisp
1068 (use-package dante
1069   :after haskell-mode
1070   :commands dante-mode
1071   :hook (haskell-mode . dante-mode))
1072 #+end_src
1073
1074 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
1075
1076 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
1077 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
1078
1079 #+begin_src emacs-lisp
1080 (use-package hlint-refactor
1081   :bind (:map hlint-refactor-mode-map
1082               ("C-c l b" . hlint-refactor-refactor-buffer)
1083               ("C-c l r" . hlint-refactor-refactor-at-point))
1084   :hook (haskell-mode . hlint-refactor-mode))
1085 #+end_src
1086
1087 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
1088
1089 #+begin_src emacs-lisp
1090 (use-package flycheck-haskell)
1091 #+end_src
1092
1093 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
1094 :PROPERTIES:
1095 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
1096 :END:
1097
1098 Currently using =flycheck-haskell= with the =haskell-hlint= checker
1099 instead.
1100
1101 #+begin_src emacs-lisp :tangle no
1102 ;;; hs-lint.el --- minor mode for HLint code checking
1103
1104 ;; Copyright 2009 (C) Alex Ott
1105 ;;
1106 ;; Author: Alex Ott <alexott@gmail.com>
1107 ;; Keywords: haskell, lint, HLint
1108 ;; Requirements:
1109 ;; Status: distributed under terms of GPL2 or above
1110
1111 ;; Typical message from HLint looks like:
1112 ;;
1113 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1114 ;; Found:
1115 ;;   count1 p l = length (filter p l)
1116 ;; Why not:
1117 ;;   count1 p = length . filter p
1118
1119
1120 (require 'compile)
1121
1122 (defgroup hs-lint nil
1123   "Run HLint as inferior of Emacs, parse error messages."
1124   :group 'tools
1125   :group 'haskell)
1126
1127 (defcustom hs-lint-command "hlint"
1128   "The default hs-lint command for \\[hlint]."
1129   :type 'string
1130   :group 'hs-lint)
1131
1132 (defcustom hs-lint-save-files t
1133   "Save modified files when run HLint or no (ask user)"
1134   :type 'boolean
1135   :group 'hs-lint)
1136
1137 (defcustom hs-lint-replace-with-suggestions nil
1138   "Replace user's code with suggested replacements"
1139   :type 'boolean
1140   :group 'hs-lint)
1141
1142 (defcustom hs-lint-replace-without-ask nil
1143   "Replace user's code with suggested replacements automatically"
1144   :type 'boolean
1145   :group 'hs-lint)
1146
1147 (defun hs-lint-process-setup ()
1148   "Setup compilation variables and buffer for `hlint'."
1149   (run-hooks 'hs-lint-setup-hook))
1150
1151 ;; regex for replace suggestions
1152 ;;
1153 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1154 ;; Found:
1155 ;; \s +\(.*\)
1156 ;; Why not:
1157 ;; \s +\(.*\)
1158
1159 (defvar hs-lint-regex
1160   "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1161   "Regex for HLint messages")
1162
1163 (defun make-short-string (str maxlen)
1164   (if (< (length str) maxlen)
1165       str
1166     (concat (substring str 0 (- maxlen 3)) "...")))
1167
1168 (defun hs-lint-replace-suggestions ()
1169   "Perform actual replacement of suggestions"
1170   (goto-char (point-min))
1171   (while (re-search-forward hs-lint-regex nil t)
1172     (let* ((fname (match-string 1))
1173           (fline (string-to-number (match-string 2)))
1174           (old-code (match-string 4))
1175           (new-code (match-string 5))
1176           (msg (concat "Replace '" (make-short-string old-code 30)
1177                        "' with '" (make-short-string new-code 30) "'"))
1178           (bline 0)
1179           (eline 0)
1180           (spos 0)
1181           (new-old-code ""))
1182       (save-excursion
1183         (switch-to-buffer (get-file-buffer fname))
1184         (goto-char (point-min))
1185         (forward-line (1- fline))
1186         (beginning-of-line)
1187         (setf bline (point))
1188         (when (or hs-lint-replace-without-ask
1189                   (yes-or-no-p msg))
1190           (end-of-line)
1191           (setf eline (point))
1192           (beginning-of-line)
1193           (setf old-code (regexp-quote old-code))
1194           (while (string-match "\\\\ " old-code spos)
1195             (setf new-old-code (concat new-old-code
1196                                  (substring old-code spos (match-beginning 0))
1197                                  "\\ *"))
1198             (setf spos (match-end 0)))
1199           (setf new-old-code (concat new-old-code (substring old-code spos)))
1200           (remove-text-properties bline eline '(composition nil))
1201           (when (re-search-forward new-old-code eline t)
1202             (replace-match new-code nil t)))))))
1203
1204 (defun hs-lint-finish-hook (buf msg)
1205   "Function, that is executed at the end of HLint execution"
1206   (if hs-lint-replace-with-suggestions
1207       (hs-lint-replace-suggestions)
1208       (next-error 1 t)))
1209
1210 (define-compilation-mode hs-lint-mode "HLint"
1211   "Mode for check Haskell source code."
1212   (set (make-local-variable 'compilation-process-setup-function)
1213        'hs-lint-process-setup)
1214   (set (make-local-variable 'compilation-disable-input) t)
1215   (set (make-local-variable 'compilation-scroll-output) nil)
1216   (set (make-local-variable 'compilation-finish-functions)
1217        (list 'hs-lint-finish-hook))
1218   )
1219
1220 (defun hs-lint ()
1221   "Run HLint for current buffer with haskell source"
1222   (interactive)
1223   (save-some-buffers hs-lint-save-files)
1224   (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1225                      'hs-lint-mode))
1226
1227 (provide 'hs-lint)
1228 ;;; hs-lint.el ends here
1229 #+end_src
1230
1231 #+begin_src emacs-lisp :tangle no
1232 (use-package hs-lint
1233   :load-path "lisp/"
1234   :bind (:map haskell-mode-map
1235               ("C-c l l" . hs-lint)))
1236 #+end_src
1237
1238 ** Web dev
1239
1240 *** SGML and HTML
1241
1242 #+begin_src emacs-lisp
1243 (use-package sgml-mode
1244   :config
1245   (setq sgml-basic-offset 2))
1246 #+end_src
1247
1248 *** CSS and SCSS
1249
1250 #+begin_src emacs-lisp
1251 (use-package css-mode
1252   :config
1253   (setq css-indent-offset 2))
1254 #+end_src
1255
1256 *** Web mode
1257
1258 #+begin_src emacs-lisp
1259 (use-package web-mode
1260   :mode "\\.html\\'"
1261   :config
1262   (setq-every! 2
1263     web-mode-code-indent-offset
1264     web-mode-css-indent-offset
1265     web-mode-markup-indent-offset))
1266 #+end_src
1267
1268 *** Emmet mode
1269
1270 #+begin_src emacs-lisp
1271 (use-package emmet-mode
1272   :bind* (("C-)" . emmet-next-edit-point)
1273           ("C-(" . emmet-prev-edit-point))
1274   :init
1275   (setq emmet-move-cursor-between-quotes t)
1276   :hook (web-mode css-mode html-mode sgml-mode))
1277 #+end_src
1278
1279 * Emacs Enhancements
1280
1281 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1282
1283 #+begin_quote
1284 Emacs package that displays available keybindings in popup
1285 #+end_quote
1286
1287 #+begin_src emacs-lisp
1288 (use-package which-key
1289   :defer 1
1290   :config (which-key-mode))
1291 #+end_src
1292
1293 ** [[https://github.com/seagle0128/doom-modeline][doom-modeline]]
1294
1295 #+begin_src emacs-lisp
1296 (use-package doom-modeline
1297   :demand t
1298   :config (setq doom-modeline-height 32)
1299   :hook (after-init . doom-modeline-init))
1300 #+end_src
1301
1302 ** [[https://github.com/11111000000/tao-theme-emacs][tao-theme]]
1303
1304 #+begin_src emacs-lisp :tangle no
1305 (use-package tao-theme
1306   :demand t
1307   :config (load-theme 'tao-yang t))
1308 #+end_src
1309
1310 ** [[https://github.com/maio/eink-emacs][eink-theme]]
1311
1312 #+begin_src emacs-lisp
1313 (load-theme 'eink t)
1314 #+end_src
1315
1316 ** [[https://github.com/bbatsov/crux][crux]]
1317
1318 #+begin_src emacs-lisp
1319 (use-package crux
1320   :bind (("C-c d"   . crux-duplicate-current-line-or-region)
1321          ("C-c M-d" . crux-duplicate-and-comment-current-line-or-region)
1322          ("C-c b K" . crux-kill-other-buffers)
1323          ("C-c f c" . crux-copy-file-preserve-attributes)
1324          ("C-c f D" . crux-delete-file-and-buffer)
1325          ("C-c f R" . crux-rename-file-and-buffer)
1326          ("C-S-j"   . crux-top-join-line)
1327          ("C-c j"   . crux-top-join-line)))
1328 #+end_src
1329
1330 ** [[https://github.com/alezost/mwim.el][mwim]]
1331
1332 #+begin_src emacs-lisp
1333 (use-package mwim
1334   :bind (("C-a"    . mwim-beginning-of-code-or-line)
1335          ("C-e"    . mwim-end-of-code-or-line)
1336          ("<home>" . mwim-beginning-of-line-or-code)
1337          ("<end>"  . mwim-end-of-line-or-code)))
1338 #+end_src
1339
1340 ** projectile
1341
1342 #+begin_src emacs-lisp
1343 (use-package projectile
1344   :defer 5
1345   :bind-keymap ("C-c p" . projectile-command-map)
1346   :config
1347   (projectile-mode)
1348
1349   (defun my-projectile-invalidate-cache (&rest _args)
1350     ;; ignore the args to `magit-checkout'
1351     (projectile-invalidate-cache nil))
1352
1353   (eval-after-load 'magit-branch
1354     '(progn
1355        (advice-add 'magit-checkout
1356                    :after #'my-projectile-invalidate-cache)
1357        (advice-add 'magit-branch-and-checkout
1358                    :after #'my-projectile-invalidate-cache))))
1359 #+end_src
1360
1361 ** [[https://github.com/Wilfred/helpful][helpful]]
1362
1363 #+begin_src emacs-lisp
1364 (use-package helpful
1365   :bind
1366   (("C-h f"   . helpful-callable)
1367    ("C-h v"   . helpful-variable)
1368    ("C-h k"   . helpful-key)
1369    ("C-c C-d" . helpful-at-point)
1370    ("C-h F"   . helpful-function)
1371    ("C-h C"   . helpful-command)))
1372 #+end_src
1373
1374 ** [[https://github.com/kyagi/shell-pop-el][shell-pop]]
1375
1376 #+begin_src emacs-lisp
1377 (use-package shell-pop
1378   :custom
1379   (shell-pop-universal-key "C-c e")
1380   (shell-pop-shell-type '("eshell" "*eshell*" (lambda nil (eshell)))))
1381 #+end_src
1382
1383 ** [[https://github.com/EricCrosson/unkillable-scratch][unkillable-scratch]]
1384
1385 Make =*scratch*= and =*Messages*= unkillable.
1386
1387 #+begin_src emacs-lisp
1388 (use-package unkillable-scratch
1389   :config
1390   (unkillable-scratch 1)
1391   :custom
1392   (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$")))
1393 #+end_src
1394
1395 ** [[https://github.com/davep/boxquote.el][boxquote.el]]
1396
1397 #+begin_example
1398 ,----
1399 | make pretty boxed quotes like this
1400 `----
1401 #+end_example
1402
1403 #+begin_src emacs-lisp
1404 (use-package boxquote
1405   :bind
1406   (:prefix-map amin--boxquote-prefix-map
1407    :prefix "C-c q"
1408    ("b"   . boxquote-buffer)
1409    ("B"   . boxquote-insert-buffer)
1410    ("d"   . boxquote-defun)
1411    ("F"   . boxquote-insert-file)
1412    ("hf"  . boxquote-describe-function)
1413    ("hk"  . boxquote-describe-key)
1414    ("hv"  . boxquote-describe-variable)
1415    ("hw"  . boxquote-where-is)
1416    ("k"   . boxquote-kill)
1417    ("p"   . boxquote-paragraph)
1418    ("q"   . boxquote-boxquote)
1419    ("r"   . boxquote-region)
1420    ("s"   . boxquote-shell-command)
1421    ("t"   . boxquote-text)
1422    ("T"   . boxquote-title)
1423    ("u"   . boxquote-unbox)
1424    ("U"   . boxquote-unbox-region)
1425    ("y"   . boxquote-yank)
1426    ("M-q" . boxquote-fill-paragraph)
1427    ("M-w" . boxquote-kill-ring-save)))
1428 #+end_src
1429
1430 Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]].
1431
1432 ** [[https://github.com/DarthFennec/highlight-indent-guides][highlight-indent-guides]]
1433
1434 #+begin_src emacs-lisp
1435 (use-package highlight-indent-guides
1436   :demand t
1437   :hook ((prog-mode . highlight-indent-guides-mode)
1438          (org-mode  . highlight-indent-guides-mode))
1439   :config
1440   (setq highlight-indent-guides-character ?\|)
1441   (setq highlight-indent-guides-auto-enabled nil)
1442   (setq highlight-indent-guides-method 'character)
1443   (setq highlight-indent-guides-responsive 'top)
1444   (set-face-foreground 'highlight-indent-guides-character-face "gainsboro")
1445   (set-face-foreground 'highlight-indent-guides-top-character-face "grey40")) ; grey13 is nice too
1446 #+end_src
1447
1448 * Email
1449 ** [[https://notmuchmail.org][notmuch]]
1450
1451 See [[notmuch:id:87muuqsvci.fsf@fencepost.gnu.org][bug follow-up]].
1452
1453 #+begin_src emacs-lisp
1454 (defvar amin-maildir "~/mail")
1455
1456 (use-package sendmail
1457   ;; :ensure nil
1458   :config
1459   (setq sendmail-program "/usr/bin/msmtp"
1460         ; message-sendmail-extra-arguments '("-v" "-d")
1461         mail-specify-envelope-from t
1462         mail-envelope-from 'header))
1463
1464 (use-package message
1465   ;; :ensure nil
1466   :config
1467   (setq message-kill-buffer-on-exit t
1468         message-send-mail-function 'message-send-mail-with-sendmail
1469         message-sendmail-envelope-from 'header
1470         message-directory "drafts"
1471         message-user-fqdn "aminb.org")
1472   (add-hook 'message-mode-hook
1473             (lambda () (setq fill-column 65
1474                         message-fill-column 65)))
1475   (add-hook 'message-mode-hook
1476             #'flyspell-mode)
1477   ;; (add-hook 'notmuch-message-mode-hook #'+doom-modeline|set-special-modeline)
1478   ;; TODO: is there a way to only run this when replying and not composing?
1479   ;; (add-hook 'notmuch-message-mode-hook
1480   ;;           (lambda () (progn
1481   ;;                   (newline)
1482   ;;                   (newline)
1483   ;;                   (forward-line -1)
1484   ;;                   (forward-line -1))))
1485   ;; (add-hook 'message-setup-hook
1486   ;;           #'mml-secure-message-sign-pgpmime)
1487   )
1488
1489 (after! mml-sec
1490   (setq mml-secure-openpgp-encrypt-to-self t
1491         mml-secure-openpgp-sign-with-sender t))
1492
1493 (defun amin/notmuch ()
1494   "Delete other windows, then launch `notmuch'."
1495   (interactive)
1496   (delete-other-windows)
1497   (notmuch))
1498
1499 (use-package notmuch
1500   :commands notmuch
1501   :bind ("C-c m" . amin/notmuch)
1502   :custom (notmuch-always-prompt-for-sender t)
1503   :config
1504   (setq notmuch-hello-sections
1505         '(notmuch-hello-insert-header
1506           notmuch-hello-insert-saved-searches
1507           ;; notmuch-hello-insert-search
1508           notmuch-hello-insert-alltags)
1509         notmuch-search-oldest-first nil
1510         notmuch-show-all-tags-list t
1511         notmuch-message-headers  ; see bug follow-up above
1512         '("Subject" "To" "Cc" "Date" "List-Id" "X-RT-Originator")
1513         notmuch-hello-thousands-separator ","
1514         notmuch-fcc-dirs
1515         '(("amin@aminb.org"        . "amin/Sent")
1516           ("amin@gnu.org"          . "gnu/Sent")
1517           ("abandali@uwaterloo.ca" . "\"uwaterloo/Sent Items\"")
1518           ("mab@gnu.org"           . "gnu/Sent")
1519           ("aminb@gnu.org"         . "gnu/Sent")
1520           (".*"                    . "sent"))
1521         notmuch-search-result-format
1522         '(("date"    . "%12s ")
1523           ("count"   . "%-7s ")
1524           ("authors" . "%-40s ")
1525           ("subject" . "%s ")
1526           ("tags"    . "(%s)"))
1527         notmuch-saved-searches
1528         '((:name "inbox"     :query "tag:inbox"     :key "i")
1529           (:name "unread"    :query "tag:unread"    :key "u")
1530           (:name "latest"    :query "tag:latest"    :key "l")
1531           (:name "encrypted" :query "tag:encrypted" :key "e")
1532           (:name "flagged"   :query "tag:flagged"   :key "f")
1533           (:name "sent"      :query "tag:sent"      :key "s")
1534           (:name "drafts"    :query "tag:draft"     :key "d")
1535           (:name "all mail"  :query "*"             :key "a")))
1536   ;; (add-hook 'visual-fill-column-mode-hook
1537   ;;           (lambda ()
1538   ;;             (when (string= major-mode 'notmuch-message-mode)
1539   ;;               (setq visual-fill-column-width 70))))
1540   ;; (set! :evil-state 'notmuch-message-mode 'insert)
1541   ;; (advice-add #'notmuch-bury-or-kill-this-buffer
1542   ;;             :override #'kill-this-buffer)
1543   :bind
1544   (:map notmuch-hello-mode-map
1545         ("u" . (lambda ()
1546                  "Search for `unread'-tagged messages"
1547                  (interactive)
1548                  (notmuch-hello-search "tag:unread")))
1549         ("i" . (lambda ()
1550                  "Search for `inbox'-tagged messages"
1551                  (interactive)
1552                  (notmuch-hello-search "tag:inbox")))
1553         ("l" . (lambda ()
1554                  "Search for `latest'-tagged messages"
1555                  (interactive)
1556                  (notmuch-hello-search "tag:latest")))
1557         ("e" . (lambda ()
1558                  "Search for `encrypted'-tagged messages"
1559                  (interactive)
1560                  (notmuch-hello-search "tag:encrypted"))))
1561   (:map notmuch-search-mode-map
1562         ("k" . (lambda ()
1563                  "Mark message read"
1564                  (interactive)
1565                  (notmuch-search-tag '("-unread"))
1566                  ;; (notmuch-search-archive-thread)
1567                  (notmuch-search-next-thread)))
1568         ("u" . (lambda ()
1569                  "Mark message unread"
1570                  (interactive)
1571                  (notmuch-search-tag '("+unread"))
1572                  (notmuch-search-next-thread)))
1573         ("K" . (lambda ()
1574                  "Mark message deleted"
1575                  (interactive)
1576                  (notmuch-search-tag '("-unread" "-inbox" "+deleted"))
1577                  (notmuch-search-next-thread)))
1578         ("S" . (lambda ()
1579                  "Mark message as spam"
1580                  (interactive)
1581                  (notmuch-search-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1582                  (notmuch-search-next-thread))))
1583   (:map notmuch-tree-mode-map
1584         ("k" . (lambda ()
1585                  "Mark message read"
1586                  (interactive)
1587                  (notmuch-tree-tag '("-unread"))
1588                  ;; (notmuch-tree-archive-thread)
1589                  (notmuch-tree-next-message)))
1590         ("u" . (lambda ()
1591                  "Mark message unread"
1592                  (interactive)
1593                  (notmuch-tree-tag '("+unread"))
1594                  (notmuch-tree-next-message)))
1595         ("K" . (lambda ()
1596                  "Mark message deleted"
1597                  (interactive)
1598                  (notmuch-tree-tag '("-unread" "-inbox" "+deleted"))
1599                  (notmuch-tree-next-message)))
1600         ("S" . (lambda ()
1601                  "Mark message as spam"
1602                  (interactive)
1603                  (notmuch-tree-tag '("-unread" "-inbox" "-webmasters" "+spam"))
1604                  (notmuch-tree-next-message)))))
1605
1606 (use-package counsel-notmuch
1607   :bind ("C-c s m" . counsel-notmuch))
1608
1609 (after! notmuch-crypto
1610   (setq notmuch-crypto-process-mime t))
1611
1612 (after! recentf
1613   (add-to-list 'recentf-exclude (expand-file-name amin-maildir)))
1614 #+end_src
1615
1616 ** supercite
1617
1618 #+begin_src emacs-lisp :tangle no
1619 (use-package supercite
1620   :commands sc-cite-original
1621   :init
1622   (add-hook 'mail-citation-hook 'sc-cite-original)
1623
1624   (defun sc-remove-existing-signature ()
1625     (save-excursion
1626       (goto-char (region-beginning))
1627       (when (re-search-forward message-signature-separator (region-end) t)
1628         (delete-region (match-beginning 0) (region-end)))))
1629
1630   (add-hook 'mail-citation-hook 'sc-remove-existing-signature)
1631
1632   (defun sc-remove-if-not-mailing-list ()
1633     (unless (assoc "list-id" sc-mail-info)
1634       (setq attribution sc-default-attribution
1635             citation (concat sc-citation-delimiter
1636                              sc-citation-separator))))
1637
1638   (add-hook 'sc-attribs-postselect-hook 'sc-remove-if-not-mailing-list)
1639
1640   :config
1641   (defun sc-fill-if-different (&optional prefix)
1642     "Fill the region bounded by `sc-fill-begin' and point.
1643 Only fill if optional PREFIX is different than
1644 `sc-fill-line-prefix'.  If `sc-auto-fill-region-p' is nil, do not
1645 fill region.  If PREFIX is not supplied, initialize fill
1646 variables.  This is useful for a regi `begin' frame-entry."
1647     (if (not prefix)
1648         (setq sc-fill-line-prefix ""
1649               sc-fill-begin (line-beginning-position))
1650       (if (and sc-auto-fill-region-p
1651                (not (string= prefix sc-fill-line-prefix)))
1652           (let ((fill-prefix sc-fill-line-prefix))
1653             (unless (or (string= fill-prefix "")
1654                         (save-excursion
1655                           (goto-char sc-fill-begin)
1656                           (or (looking-at ">+  +")
1657                               (< (length
1658                                   (buffer-substring (point)
1659                                                     (line-end-position)))
1660                                  65))))
1661               (fill-region sc-fill-begin (line-beginning-position)))
1662             (setq sc-fill-line-prefix prefix
1663                   sc-fill-begin (line-beginning-position)))))
1664 nil))
1665 #+end_src
1666
1667 * Blogging
1668 ** [[https://ox-hugo.scripter.co][ox-hugo]]
1669
1670 #+begin_src emacs-lisp
1671 (use-package ox-hugo
1672   :after ox)
1673 #+end_src
1674
1675 * Post initialization
1676 :PROPERTIES:
1677 :CUSTOM_ID: post-initialization
1678 :END:
1679
1680 Display how long it took to load the init file.
1681
1682 #+begin_src emacs-lisp
1683 (message "Loading %s...done (%.3fs)" user-init-file
1684          (float-time (time-subtract (current-time)
1685                                     amin--before-user-init-time)))
1686 #+end_src
1687
1688 * Footer
1689 :PROPERTIES:
1690 :CUSTOM_ID: footer
1691 :END:
1692
1693 #+begin_src emacs-lisp :comments none
1694 ;;; init.el ends here
1695 #+end_src
1696
1697 * COMMENT Local Variables                                           :ARCHIVE:
1698 # Local Variables:
1699 # eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)
1700 # End: