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