about summary refs log tree commit diff stats
path: root/README.md
blob: d6b2457d592ff2e0d1c2a595a949f7f19d304232 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
Why the hell not, let’s do this again.


# Basics


## About me

    (setq user-full-name "Case Duckworth"
          user-mail-address "acdw@acdw.net")


## Correct `exec-path`

Straight depends on Git, so I need to tell Emacs where different paths are.

    (let ((win-downloads "c:/Users/aduckworth/Downloads"))
      (dolist (path (list
    		 ;; Linux
    		 (expand-file-name "bin"
    				   user-emacs-directory)
    		 (expand-file-name "~/bin")
    		 (expand-file-name "~/.local/bin")
    		 (expand-file-name "~/Scripts")
    		 ;; Windows
    		 (expand-file-name "emacs/bin"
    				   win-downloads)
    		 (expand-file-name "m/usr/bin"
    				   win-downloads)
    		 (expand-file-name "m/mingw64/bin"
    				   win-downloads)
    		 (expand-file-name "PortableGit/bin"
    				   win-downloads)
    		 (expand-file-name "PortableGit/usr/bin"
    				   win-downloads)))
        (when (file-exists-p path)
          (add-to-list 'exec-path path))))


## Package management


### Straight.el

Straight can't bootstrap itself on Windows, so I've wrapped the
bootstrap code from straight's repo in a function.

    (defun acdw/bootstrap-straight ()
      "Bootstrap straight.el."
      (defvar bootstrap-version)
      (let ((bootstrap-file
    	 (expand-file-name
    	  "straight/repos/straight.el/bootstrap.el"
    	  user-emacs-directory))
    	(bootstrap-version 5))
        (unless (file-exists-p bootstrap-file)
          (with-current-buffer
    	  (url-retrieve-synchronously
    	   (concat
    	    "https://raw.githubusercontent.com/"
    	    "raxod502/straight.el/"
    	    "develop/install.el")
    	   'silent 'inhibit-cookies)
    	(goto-char (point-max))
    	(eval-print-last-sexp)))
        (load bootstrap-file nil 'nomessage)))

Now, I'll *try* running it regular-style, ignoring the errors.  If it
doesn't work, I'll call git directly and clone the repo myself.

    (unless (ignore-errors (acdw/bootstrap-straight))
      (message "%s" "Straight.el didn't bootstrap correctly.  Cloning directly...")
      (call-process "git" nil
    		(get-buffer-create "*bootstrap-straight-messages*") nil
    		"clone"
    		"https://github.com/raxod502/straight.el"
    		(expand-file-name "straight/repos/straight.el"
    				  user-emacs-directory))
      (acdw/bootstrap-straight))


## Customize macros


### Emulate use-package’s `:custom`

    (defmacro cuss (var val &optional docstring)
      "Basically, `:custom' from `use-package', but without `use-package'."
      (declare (doc-string 3)
    	   (indent 2))
      `(funcall (or (get ',var 'custom-set) #'set-default)
    	    ',var ,val))


### Emulate use-package’s `:custom-face`, but better

    (defvar acdw--custom-faces ()
      "List of custom faces to run through acdw/set-custom-faces.")
    
    (defun acdw/set-custom-faces ()
      "Run `customize-set-faces' on `acdw--custom-faces'."
      (message "%s" "Customizing faces...")
      (apply #'custom-set-faces acdw--custom-faces))
    
    (defun cussface (spec)
      "Add SPEC to `acdw--custom-faces', and add a hook to run
    `acdw/set-custom-faces' after init."
      (add-to-list 'acdw--custom-faces spec)
      (add-hook 'after-init-hook #'acdw/set-custom-faces))


## Clean `.emacs.d`

    (straight-use-package 'no-littering)
    (require 'no-littering)


### Don’t clutter `init.el` with customizations

    (with-eval-after-load 'no-littering 
      (cuss custom-file (no-littering-expand-etc-file-name "custom.el")))


## Look and feel


### Cursor

    (cuss cursor-type 'bar
      "Show a vertical bar for the cursor.")
    
    (cuss cursor-in-non-selected-windows 'hbar
      "Show an empty box in inactive windows.")
    
    ;; Don't blink the cursor
    (blink-cursor-mode -1)


### Tool Bars

1.  Tool bars and menu bars

        (cuss default-frame-alist
              '((tool-bar-lines . 0)
        	(menu-bar-lines .0))
          "Setup the default frame alist.")
        
        (menu-bar-mode -1)
        (tool-bar-mode -1)

2.  Scroll bars

        (add-to-list 'default-frame-alist
        	     '(vertical-scroll-bars . nil))
        
        (scroll-bar-mode -1)
        
        (add-to-list 'default-frame-alist
        	     '(horizontal-scroll-bars . nil))
        
        (horizontal-scroll-bar-mode -1)


### Dialogs

    (cuss use-dialog-box nil
      "Don't use dialog boxes to ask questions.")

1.  Yes or no questions

        (fset 'yes-or-no-p #'y-or-n-p)

2.  The Bell

        (defun acdw/ring-bell-function ()
          "Ring the bell."
          (let ((orig-face (face-foreground 'mode-line)))
            (set-face-foreground 'mode-line "#F2804F")
            (run-with-idle-timer
             0.1 nil
             (lambda (fg)
               (set-face-foreground 'mode-line fg))
             orig-face)))
        
        (cuss ring-bell-function #'acdw/ring-bell-function)


### Frames

1.  Fringes

        (cuss indicate-empty-lines t
          "Show an indicator on the left fringe of empty lines past the
        end of the buffer.")
        (cuss indicate-buffer-boundaries 'right
          "Indicate the beginning and end of the buffer and whether it
          scrolls off-window in the right fringe.")

2.  Minibuffer

        (cuss minibuffer-prompt-properties
            '(read-only t cursor-intangible t face minibuffer-prompt)
          "Keep the cursor away from the minibuffer prompt.")

3.  Tabs

        (cuss tab-bar-tab-name-function
            #'tab-bar-tab-name-current-with-count
          "Show the tab name as the name of the current buffer, plus a
          count of the windows in the tab.")
        
        (cuss tab-bar-show 1
          "Show the tab bar, when there's more than one tab.")


### Windows

1.  Winner mode

        (when (fboundp 'winner-mode)
          (winner-mode +1))

2.  Switch windows

        (global-set-key (kbd "M-o") #'other-window)


### Buffers

1.  Uniquify buffers

        (require 'uniquify)
        (cuss uniquify-buffer-name-style 'forward
          "Uniquify buffers' names by going up the path trees until they
        become unique.")

2.  Startup buffers

        (cuss inhibit-startup-screen t
          "Don't show Emacs' startup buffer.")
        
        (cuss initial-buffer-choice t
          "Start with *scratch*.")
        
        (cuss initial-scratch-message ""
          "Empty *scratch* buffer.")


### Modeline

1.  Smart mode line

        (straight-use-package 'smart-mode-line)
        
        (cuss sml/no-confirm-load-theme t
          "Pass the NO-CONFIRM flag to `load-theme'.")
        
        (sml/setup)

2.  Rich minority

    Since this *comes* with smart mode line, I’m just going to use it,
    instead of `diminish` or another package.  I do have to write this
    helper function, though, to add things to the whitelist.
    
        (defun rm/whitelist-add (regexp)
          "Add a REGEXP to the whitelist for `rich-minority'."
          (if (listp 'rm--whitelist-regexps)
              (add-to-list 'rm--whitelist-regexps regexp)
            (setq rm--whitelist-regexps `(,regexp)))
          (setq rm-whitelist
        	(mapconcat 'identity rm--whitelist-regexps "\\|")))
        
        (straight-use-package 'rich-minority)
        
        (rm/whitelist-add "^$")


### Theme

1.  Modus Themes

        (straight-use-package 'modus-themes)
        
        (cuss modus-themes-slanted-constructs t
          "Use more slanted constructs.")
        (cuss modus-themes-bold-constructs t
          "Use more bold constructs.")
        
        (cuss modus-themes-region 'bg-only
          "Only highlight the background of the selected region.")
        
        (cuss modus-themes-org-blocks 'grayscale
          "Show org-blocks with a grayscale background.")
        (cuss modus-themes-headings
            '((1 . line)
              (t . t))
          "Highlight top headings with `line' style, and others by default.")
        
        (cuss modus-themes-scale-headings t
          "Scale headings by the ratios below.")
        (cuss modus-themes-scale-1 1.1)
        (cuss modus-themes-scale-2 1.15)
        (cuss modus-themes-scale-3 1.21)
        (cuss modus-themes-scale-4 1.27)
        (cuss modus-themes-scale-5 1.33)
        
        (load-theme 'modus-operandi t)


### Fonts

1.  Define fonts

        (defun set-face-from-alternatives (face fonts)
          (catch :return
            (dolist (font fonts)
              (when (find-font (font-spec :family (car font)))
        	(apply #'set-face-attribute `(,face
        				      nil
        				      :family (car font)
        				      ,@(cdr font)))
        	(throw :return font)))))
        
        (defun acdw/setup-fonts ()
          "Setup fonts.  This has to happen after the frame is setup for
        the first time, so it should be added to `window-setup-hook'.  It
        removes itself from that hook."
          (interactive)
          (when (display-graphic-p)
            (set-face-from-alternatives 'default
        				'(("Input Mono"
        				   :height 105)
        				  ("Go Mono"
        				   :height 100)
        				  ("Consolas"
        				   :height 100)))
        
            (set-face-from-alternatives 'fixed-pitch
        				'(("Input Mono")
        				  ("Go Mono")
        				  ("Consolas")))
        
            (set-face-from-alternatives 'variable-pitch
        				'(("Input Serif")
        				  ("Georgia")))
        
            (remove-function after-focus-change-function #'acdw/setup-fonts)))
        
        (add-function :before after-focus-change-function #'acdw/setup-fonts)

2.  Custom faces

        (cussface '(font-lock-comment-face
        	    ((t (:inherit (custom-comment italic variable-pitch))))))

3.  Line spacing

        (cuss line-spacing 0.1
          "Add 10% extra space below each line.")

4.  Underlines

        (cuss x-underline-at-descent-line t
          "Draw the underline at the same place as the descent line.")

5.  Unicode Fonts

        (straight-use-package 'unicode-fonts)
        (require 'unicode-fonts)
        (unicode-fonts-setup)


## Interactivity


### Completing read

1.  Shadow file names in `completing-read`.

        (cuss file-name-shadow-properties '(invisible t))
        
        (file-name-shadow-mode +1)

2.  Ignore case in `completing-read`

        (cuss completion-ignore-case t)
        (cuss read-buffer-completion-ignore-case t)
        (cuss read-file-name-completion-ignore-case t)

3.  Minibuffer recursivity

        (cuss enable-recursive-minibuffers t)
        (minibuffer-depth-indicate-mode +1)

4.  Selectrum

        (straight-use-package 'selectrum)
        (require 'selectrum)
        (selectrum-mode +1)

5.  Prescient

        (straight-use-package 'prescient)
        (require 'prescient)
        (prescient-persist-mode +1)
        
        (straight-use-package 'selectrum-prescient)
        (require 'selectrum-prescient)
        (selectrum-prescient-mode +1)

6.  Consult

        (straight-use-package '(consult
        			:host github
        			:repo "minad/consult"))
        (require 'consult)
        
        (straight-use-package '(consult-selectrum
        			:host github
        			:repo "minad/consult"))
        (require 'consult-selectrum)
        
        (with-eval-after-load 'consult
          (define-key ctl-x-map "b" #'consult-buffer)
          (define-key ctl-x-map (kbd "C-r") #'consult-buffer)
          (define-key ctl-x-map "4b" #'consult-buffer-other-window)
          (define-key ctl-x-map "5b" #'consult-buffer-other-frame)
        
          (define-key goto-map "o" #'consult-outline)
          (define-key goto-map "g" #'consult-line)
          (define-key goto-map (kbd "M-g") #'consult-line)
          (define-key goto-map "l" #'consult-line)
          (define-key goto-map "m" #'consult-mark)
          (define-key goto-map "i" #'consult-imenu)
          (define-key goto-map "e" #'consult-error)
        
          (global-set-key (kbd "M-y") #'consult-yank-pop)
        
          (define-key help-map "a" #'consult-apropos)
        
          (fset 'multi-occur #'consult-multi-occur))

7.  Marginalia

        (straight-use-package '(marginalia
        			:host github
        			:repo "minad/marginalia"
        			:branch "main"))
        
        (cuss marginalia-annotators
            '(marginalia-annotators-heavy
              marginalia-annotators-light))
        
        (marginalia-mode +1)


### Completion

    (global-set-key (kbd "M-/") #'hippie-expand)


## Keyboard


### `ESC` cancels all

    (global-set-key (kbd "<escape>") #'keyboard-escape-quit)


### Personal prefix key: `C-z`

    (defvar acdw/map
      (let ((map (make-sparse-keymap))
    	(c-z (global-key-binding "\C-z")))
        (global-unset-key "\C-z")
        (define-key global-map "\C-z" map)
        (define-key map "\C-z" c-z)
        map))
    
    (run-hooks 'acdw/map-defined-hook)


## Mouse


### Preserve screen position when scrolling with the mouse wheel

from [u/TheFrenchPoulp](https://www.reddit.com/r/emacs/comments/km9by4/weekly_tipstricketc_thread/ghg2c9d/).

    (advice-add 'mwheel-scroll :around #'me/mwheel-scroll)
    
    (defun me/mwheel-scroll (original &rest arguments)
      "Like `mwheel-scroll' but preserve screen position.
    See `scroll-preserve-screen-position'."
      (let ((scroll-preserve-screen-position :always))
        (apply original arguments)))


## Persistence


### Minibuffer history

    (require 'savehist)
    
    (cuss savehist-additional-variables
        '(kill-ring
          search-ring
          regexp-search-ring)
      "Other variables to save alongside the minibuffer history.")
    
    (cuss history-length t
      "Don't truncate history.")
    
    (cuss history-delete-duplicates t
      "Delete history duplicates.")
    
    (savehist-mode +1)


### File places

    (require 'saveplace) ; this isn't required, but ... I like having it here
    
    (cuss save-place-forget-unreadable-files t
      "Don't check if files are readable or not.")
    
    (save-place-mode +1)


### Recent files

    (require 'recentf)
    
    (cuss recentf-max-menu-items 100
      "The maximum number of items in the recentf menu.")
    (cuss recentf-max-saved-items nil
      "Don't limit the number of recent files.")
    
    (with-eval-after-load 'no-littering
      (add-to-list 'recentf-exclude no-littering-var-directory)
      (add-to-list 'recentf-exclude no-littering-etc-directory))
    
    (recentf-mode +1)
    
    ;; save the recentf-list every 5 minutes
    (run-at-time nil (* 5 60) 'recentf-save-list)


## Undo

    (straight-use-package 'undo-fu)
    (require 'undo-fu)
    
    (global-set-key (kbd "C-/") #'undo-fu-only-undo)
    (global-set-key (kbd "C-?") #'undo-fu-only-redo)
    
    (straight-use-package 'undo-fu-session)
    (require 'undo-fu-session)
    
    (cuss undo-fu-session-incompatible-files
        '("/COMMIT_EDITMSG\\'"
          "/git-rebase-todo\\'")
      "A list of files that are incompatible with the concept of undo sessions.")
    
    (with-eval-after-load 'no-littering
      (let ((dir (no-littering-expand-var-file-name "undos")))
        (make-directory dir 'parents)
        (cuss undo-fu-session-directory dir)))
    
    (global-undo-fu-session-mode +1)


## Files


### Encoding

1.  UTF-8

        (set-language-environment "UTF-8")
        (set-terminal-coding-system 'utf-8)
        (cuss locale-coding-system 'utf-8)
        (set-default-coding-systems 'utf-8)
        (set-selection-coding-system 'utf-8)
        (prefer-coding-system 'utf-8)

2.  Convert all files to UNIX-style line endings

    from [Emacs Wiki](https://www.emacswiki.org/emacs/EndOfLineTips).
    
        (defun ewiki/no-junk-please-were-unixish ()
          "Convert line endings to UNIX, dammit."
          (let ((coding-str (symbol-name buffer-file-coding-system)))
            (when (string-match "-\\(?:dos\\|mac\\)$" coding-str)
              (set-buffer-file-coding-system 'unix))))
    
    I add it to the `find-file-hook` *and* `before-save-hook` because I
    don't want to ever work with anything other than UNIX line endings
    ever again.  I just don't care.  Even Microsoft Notepad can handle
    UNIX line endings, so I don't want to hear it.
    
        (add-hook 'find-file-hook #'ewiki/no-junk-please-were-unixish)
        (add-hook 'before-save-hook #'ewiki/no-junk-please-were-unixish)


### Backups

    (cuss backup-by-copying 1)
    (cuss delete-old-versions -1)
    (cuss version-control t)
    (cuss vc-make-backup-files t)
    
    (with-eval-after-load 'no-littering
      (let ((dir (no-littering-expand-var-file-name "backup")))
        (make-directory dir 'parents)
        (cuss backup-directory-alist
    	`((".*" . ,dir)))))


### Auto-saves

    (with-eval-after-load 'no-littering
      (let ((dir (no-littering-expand-var-file-name "autosaves")))
        (make-directory dir 'parents)
        (cuss auto-save-file-name-transforms
    	`((".*" ,dir t))))
    
      (auto-save-visited-mode +1))


### Auto-revert buffers to files on disk

    (global-auto-revert-mode +1)


### Add a timestamp to files

    (add-hook 'before-save-hook #'time-stamp)


### Require a final new line

    (cuss require-final-newline t)


## Text editing


### Operate visually on lines

    (global-visual-line-mode +1)


### Stay snappy with long-lined files

    (when (fboundp 'global-so-long-mode)
      (global-so-long-mode +1))


### Killing & Yanking

1.  Replace selection when typing

        (delete-selection-mode +1)

2.  Work better with the system clipboard

        (cuss save-interprogram-paste-before-kill t
          "Save existing clipboard text into the kill ring before
          replacing it.")
        
        (cuss yank-pop-change-selection t
          "Update the X selection when rotating the kill ring.")


### Searching & Replacing

1.  Replace with Anzu

          (straight-use-package 'anzu)
          (require 'anzu)
        
          ;; show search count in the modeline
          (global-anzu-mode +1)
        
          (cuss anzu-replace-to-string-separator " → "
            "What to separate the search from the replacement.")
        
        (global-set-key [remap query-replace] #'anzu-query-replace)
        (global-set-key [remap query-replace-regexp] #'anzu-query-replace-regexp)
        
        (define-key isearch-mode-map [remap isearch-query-replace]  #'anzu-isearch-query-replace)
        (define-key isearch-mode-map [remap isearch-query-replace-regexp] #'anzu-isearch-query-replace-regexp)


# Programming


## Parentheses


### Smart parentheses

    (straight-use-package 'smartparens)
    (require 'smartparens-config)
    
    ;; replace show-paren
    
    (cuss sp-show-pair-delay 0
      "Don't delay before showing the pairs.")
    (cuss sp-show-pair-from-inside t
      "Highlight the enclosing pair when immediately inside.")
    
    (add-hook 'prog-mode-hook #'show-smartparens-mode +1)
    
    ;; enable strict smartparens in prog mode
    (add-hook 'prog-mode-hook #'smartparens-strict-mode)


## Indent aggressively

    (straight-use-package 'aggressive-indent)
    
    (global-aggressive-indent-mode +1)


## Language-specific packages


### Emacs lisp

    (cuss eval-expression-print-length nil
      "Don't truncate printed expressions by length.")
    (cuss eval-expression-print-level nil
      "Don't truncate printed expressions by level.")


# Writing


## Visual fill column


### Fix scrolling in margins

This has to be done *before* loading the package.  It's included in `visual-fill-column`, too, but for some reason isn't loaded there.

    (global-set-key [right-margin mouse-1] (global-key-binding [mouse-1])) ; #'mouse-set-point
    (global-set-key [right-margin mouse-2] (global-key-binding [mouse-2])) ; #'mouse-yank-primary
    (global-set-key [right-margin mouse-3] (global-key-binding [mouse-3])) ; #'mouse-save-then-kill
    (global-set-key [right-margin drag-mouse-1] #'ignore)
    (global-set-key [right-margin drag-mouse-2] #'ignore)
    (global-set-key [right-margin drag-mouse-3] #'ignore)
    (global-set-key [right-margin double-mouse-1] #'ignore)
    (global-set-key [right-margin double-mouse-2] #'ignore)
    (global-set-key [right-margin double-mouse-3] #'ignore)
    (global-set-key [right-margin triple-mouse-1] #'ignore)
    (global-set-key [right-margin triple-mouse-2] #'ignore)
    (global-set-key [right-margin triple-mouse-3] #'ignore)
    (global-set-key [left-margin mouse-1] (global-key-binding [mouse-1])) ; #'mouse-set-point
    (global-set-key [left-margin mouse-2] (global-key-binding [mouse-2])) ; #'mouse-yank-primary
    (global-set-key [left-margin mouse-3] (global-key-binding [mouse-3])) ; #'mouse-save-then-kill
    (global-set-key [left-margin drag-mouse-1] #'ignore)
    (global-set-key [left-margin drag-mouse-2] #'ignore)
    (global-set-key [left-margin drag-mouse-3] #'ignore)
    (global-set-key [left-margin double-mouse-1] #'ignore)
    (global-set-key [left-margin double-mouse-2] #'ignore)
    (global-set-key [left-margin double-mouse-3] #'ignore)
    (global-set-key [left-margin triple-mouse-1] #'ignore)
    (global-set-key [left-margin triple-mouse-2] #'ignore)
    (global-set-key [left-margin triple-mouse-3] #'ignore)
    
    (mouse-wheel-mode +1)
    
    (when (bound-and-true-p mouse-wheel-mode)
      (global-set-key [right-margin mouse-wheel-down-event] #'mwheel-scroll)
      (global-set-key [right-margin mouse-wheel-up-event] #'mwheel-scroll)
      (global-set-key [right-margin wheel-down] #'mwheel-scroll)
      (global-set-key [right-margin wheel-up] #'mwheel-scroll)
      (global-set-key [left-margin mouse-wheel-down-event] #'mwheel-scroll)
      (global-set-key [left-margin mouse-wheel-up-event] #'mwheel-scroll)
      (global-set-key [left-margin wheel-down] #'mwheel-scroll)
      (global-set-key [left-margin wheel-up] #'mwheel-scroll)
      (global-set-key [right-margin mouse-4] #'mwheel-scroll)
      (global-set-key [right-margin mouse-5] #'mwheel-scroll)
      (global-set-key [left-margin mouse-4] #'mwheel-scroll)
      (global-set-key [left-margin mouse-5] #'mwheel-scroll))


### Load the package

    (straight-use-package 'visual-fill-column)
    
    (cuss visual-fill-column-center-text nil
      "Whether to center the text in the frame.")
    
    (cuss fill-column 84
      "Width of fill-column, and thus, visual-fill-column.")
    
    (advice-add 'text-scale-adjust
    	    :after #'visual-fill-column-adjust)
    
    (global-visual-fill-column-mode +1)


## Typographical niceties


### Variable pitch in text-modes

    (add-hook 'text-mode-hook #'variable-pitch-mode)


### Typo mode

    (straight-use-package 'typo)
    
    (add-hook 'text-mode-hook #'typo-mode)


# Applications


## Org mode

I’ve put org mode under Applications, as opposed to Writing, because it’s  more generally-applicable than that.


### Basics

    (straight-use-package 'org)
    
    (with-eval-after-load 'org
      (require 'org-tempo)
      (require 'ox-md)
      (define-key org-mode-map (kbd "M-n") #'outline-next-visible-heading)
      (define-key org-mode-map (kbd "M-p") #'outline-previous-visible-heading))
    
    (cuss org-hide-emphasis-markers t)
    (cuss org-fontify-done-headline t)
    (cuss org-fontify-whole-heading-line t)
    (cuss org-fontify-quote-and-verse-blocks t)
    (cuss org-pretty-entities t)
    (cuss org-src-tab-acts-natively t)
    (cuss org-src-fontify-natively t)
    (cuss org-src-window-setup 'current-window)
    (cuss org-confirm-babel-evaluate nil)
    (cuss org-directory "~/Org")
    (cuss org-ellipsis "…")

1.  Tags

        (cuss org-tags-column 0
          "Show tags directly after the headline.
        This is the best-looking option with variable-pitch fonts.")
        
        (cussface
         '(org-tag
           ((t
             (:height 0.8 :weight normal :slant italic :foreground "grey40" :inherit
        	      (variable-pitch))))))


### General

1.  [Org Return: DWIM](https://github.com/alphapapa/unpackaged.el#org-return-dwim)

        (defun unpackaged/org-element-descendant-of (type element)
          "Return non-nil if ELEMENT is a descendant of TYPE.
        TYPE should be an element type, like `item' or `paragraph'.
        ELEMENT should be a list like that returned by `org-element-context'."
          ;; MAYBE: Use `org-element-lineage'.
          (when-let* ((parent (org-element-property :parent element)))
            (or (eq type (car parent))
        	(unpackaged/org-element-descendant-of type parent))))
        
        ;;;###autoload
        (defun unpackaged/org-return-dwim (&optional default)
          "A helpful replacement for `org-return'.  With prefix, call `org-return'.
        
        On headings, move point to position after entry content.  In
        lists, insert a new item or end the list, with checkbox if
        appropriate.  In tables, insert a new row or end the table."
          ;; Inspired by John Kitchin: http://kitchingroup.cheme.cmu.edu/blog/2017/04/09/A-better-return-in-org-mode/
          (interactive "P")
          (if default
              (org-return)
            (cond
             ;; Act depending on context around point.
        
             ;; NOTE: I prefer RET to not follow links, but by uncommenting this block, links will be
             ;; followed.
        
             ;; ((eq 'link (car (org-element-context)))
             ;;  ;; Link: Open it.
             ;;  (org-open-at-point-global))
        
             ((org-at-heading-p)
              ;; Heading: Move to position after entry content.
              ;; NOTE: This is probably the most interesting feature of this function.
              (let ((heading-start (org-entry-beginning-position)))
        	(goto-char (org-entry-end-position))
        	(cond ((and (org-at-heading-p)
        		    (= heading-start (org-entry-beginning-position)))
        	       ;; Entry ends on its heading; add newline after
        	       (end-of-line)
        	       (insert "\n\n"))
        	      (t
        	       ;; Entry ends after its heading; back up
        	       (forward-line -1)
        	       (end-of-line)
        	       (when (org-at-heading-p)
        		 ;; At the same heading
        		 (forward-line)
        		 (insert "\n")
        		 (forward-line -1))
        	       ;; FIXME: looking-back is supposed to be called with more arguments.
        	       (while (not (looking-back (rx (repeat 3 (seq (optional blank) "\n"))) nil))
        		 (insert "\n"))
        	       (forward-line -1)))))
        
             ((org-at-item-checkbox-p)
              ;; Checkbox: Insert new item with checkbox.
              (org-insert-todo-heading nil))
        
             ((org-in-item-p)
              ;; Plain list.  Yes, this gets a little complicated...
              (let ((context (org-element-context)))
        	(if (or (eq 'plain-list (car context))  ; First item in list
        		(and (eq 'item (car context))
        		     (not (eq (org-element-property :contents-begin context)
        			      (org-element-property :contents-end context))))
        		(unpackaged/org-element-descendant-of 'item context))  ; Element in list item, e.g. a link
        	    ;; Non-empty item: Add new item.
        	    (org-insert-item)
        	  ;; Empty item: Close the list.
        	  ;; TODO: Do this with org functions rather than operating on the text. Can't seem to find the right function.
        	  (delete-region (line-beginning-position) (line-end-position))
        	  (insert "\n"))))
        
             ((when (fboundp 'org-inlinetask-in-task-p)
        	(org-inlinetask-in-task-p))
              ;; Inline task: Don't insert a new heading.
              (org-return))
        
             ((org-at-table-p)
              (cond ((save-excursion
        	       (beginning-of-line)
        	       ;; See `org-table-next-field'.
        	       (cl-loop with end = (line-end-position)
        			for cell = (org-element-table-cell-parser)
        			always (equal (org-element-property :contents-begin cell)
        				      (org-element-property :contents-end cell))
        			while (re-search-forward "|" end t)))
        	     ;; Empty row: end the table.
        	     (delete-region (line-beginning-position) (line-end-position))
        	     (org-return))
        	    (t
        	     ;; Non-empty row: call `org-return'.
        	     (org-return))))
             (t
              ;; All other cases: call `org-return'.
              (org-return)))))
        
        (with-eval-after-load 'org
          (define-key org-mode-map (kbd "RET") #'unpackaged/org-return-dwim))

2.  Insert blank lines around headers

    from [unpackaged.el](https://github.com/alphapapa/unpackaged.el#ensure-blank-lines-between-headings-and-before-contents).
    
        ;;;###autoload
        (defun unpackaged/org-fix-blank-lines (&optional prefix)
          "Ensure that blank lines exist between headings and between headings and their contents.
        With prefix, operate on whole buffer. Ensures that blank lines
        exist after each headings's drawers."
          (interactive "P")
          (org-map-entries (lambda ()
        		     (org-with-wide-buffer
        		      ;; `org-map-entries' narrows the buffer, which prevents us
        		      ;; from seeing newlines before the current heading, so we
        		      ;; do this part widened.
        		      (while (not (looking-back "\n\n" nil))
        			;; Insert blank lines before heading.
        			(insert "\n")))
        		     (let ((end (org-entry-end-position)))
        		       ;; Insert blank lines before entry content
        		       (forward-line)
        		       (while (and (org-at-planning-p)
        				   (< (point) (point-max)))
        			 ;; Skip planning lines
        			 (forward-line))
        		       (while (re-search-forward org-drawer-regexp end t)
        			 ;; Skip drawers. You might think that `org-at-drawer-p'
        			 ;; would suffice, but for some reason it doesn't work
        			 ;; correctly when operating on hidden text.  This
        			 ;; works, taken from `org-agenda-get-some-entry-text'.
        			 (re-search-forward "^[ \t]*:END:.*\n?" end t)
        			 (goto-char (match-end 0)))
        		       (unless (or (= (point) (point-max))
        				   (org-at-heading-p)
        				   (looking-at-p "\n"))
        			 (insert "\n"))))
        		   t (if prefix
        			 nil
        		       'tree)))
    
    1.  Add a before-save-hook
    
            (defun cribbed/org-mode-fix-blank-lines ()
              (when (eq major-mode 'org-mode)
                (let ((current-prefix-arg 4)) ; Emulate C-u
                  (call-interactively 'unpackaged/org-fix-blank-lines))))
            
            (add-hook 'before-save-hook #'cribbed/org-mode-fix-blank-lines)


### Org Agenda

    (cuss org-agenda-files
        (let ((list))
          (dolist (file '(;; add more files to this list
    		      "home.org"
    		      "work.org")
    		    list)
    	(push (expand-file-name file org-directory) list))))
    
    (define-key acdw/map (kbd "C-a") #'org-agenda)
    
    (cuss org-todo-keywords
        '((sequence "RECUR(r)" "TODO(t)" "|" "DONE(d)")
          (sequence "|" "CANCELLED(c)")))


### TODO Capture


## Git

    (straight-use-package 'magit)
    
    (define-key acdw/map "g" #'magit-status)


## Beancount mode

    (straight-use-package '(beancount-mode
    			:host github
    			:repo "beancount/beancount-mode"))
    (require 'beancount)
    
    (add-to-list 'auto-mode-alist '("\\.beancount\\'" . beancount-mode))
    
    (defun acdw/disable-aggressive-indent ()
      "Turn `aggressive-indent-mode' off for a buffer."
      (aggressive-indent-mode -1))
    
    (add-hook 'beancount-mode-hook #'outline-minor-mode)
    (add-hook 'beancount-mode-hook #'acdw/disable-aggressive-indent)
    
    (define-key beancount-mode-map (kbd "M-n") #'outline-next-visible-heading)
    (define-key beancount-mode-map (kbd "M-p") #'outline-previous-visible-heading)


# Appendices


## Emacs' files


### init.el

I realized I didn’t need `early-init.el`, since it really only set `load-prefer-newer`.  So I’ve set that here, and wrapped the actual loading of config in a `let*` form that speeds up init, and loads the newer of either `config.org` or `config.el`.

    ;; init.el -*- lexical-binding: t -*-
    
    (setq load-prefer-newer t)
    
    (let* (;; Speed up init
           (gc-cons-threshold most-positive-fixnum)
           (file-name-handler-alist nil)
           ;; Config file names
           (conf (expand-file-name "config"
    			       user-emacs-directory))
           (conf-el (concat conf ".el"))
           (conf-org (concat conf ".org")))
      (unless (and (file-newer-than-file-p conf-el conf-org)
    	       (load conf 'no-error))
        (require 'org)
        (org-babel-load-file conf-org)))


## Ease tangling and loading of Emacs' init

    (defun refresh-emacs (&optional disable-load)
      "Tangle `config.org', then byte-compile the resulting files.
    Then, load the byte-compilations unless passed with a prefix argument."
      (interactive "P")
      (let ((config (expand-file-name "config.org" user-emacs-directory)))
        (save-mark-and-excursion
          (with-current-buffer (find-file config)
    	(let ((prog-mode-hook nil))
    	  ;; generate the readme
    	  (when (file-newer-than-file-p config (expand-file-name
    						"README.md"
    						user-emacs-directory))
    	    (message "%s" "Exporting README.md...")
    	    (require 'ox-md)
    	    (with-demoted-errors "Problem exporting README.md: %S"
    	      (org-md-export-to-markdown)))
    	  ;; tangle config.org
    	  (when (file-newer-than-file-p config (expand-file-name
    						"config.el"
    						user-emacs-directory))
    	    (message "%s" "Tangling config.org...")
    	    (require 'org)
    	    (let ((inits (org-babel-tangle)))
    	      ;; byte-compile resulting files
    	      (message "%s" "Byte-compiling...")
    	      (dolist (f inits)
    		(when (string-match "\\.el\\'" f)
    		  (byte-compile-file f (not disable-load)))))))))))


## Ancillary scripts


### emacsdc

Here's a wrapper script that'll start `emacs --daemon` if there isn't
one, and then launch `emacsclient` with the arguments.  I'd recommend
installing with either `ln -s bin/emacsdc $HOME/.local/bin/`, or
adding `$HOME/.local/bin` to your `$PATH`.

    if ! emacsclient -nc "$@" 2>/dev/null; then
        emacs --daemon
        emacsclient -nc "$@"
    fi


### Emacs.cmd

Here's a wrapper script that'll run Emacs on Windows, with a custom
`$HOME`.  I have mine setup like this: Emacs is downloaded from [the
GNU mirror](https://mirrors.tripadvisor.com/gnu/emacs/windows/emacs-27/emacs-27.1-x86_64.zip) and unzipped to `~/Downloads/emacs/`.  `Emacs.cmd` sets
`$HOME` to `~/Downloads/emacshome/`, which is where `.emacs.d` is, and
whatever else I might want to throw in there.

    set HOME=%~dp0..\..\emacshome
    
    REM Run "Quick Mode"
    REM "%~dp0runemacs.exe" -Q %*
    
    REM Regular
    "%~dp0runemacs.exe" %*


## License

Copyright © 2020 Case Duckworth <acdw@acdw.net>

This work is free.  You can redistribute it and/or modify it under the
terms of the Do What the Fuck You Want To Public License, Version 2,
as published by Sam Hocevar.  See the `LICENSE` file, tangled from the
following source block, for details.

    DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
    
    Version 2, December 2004
    
    Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
    
    Everyone is permitted to copy and distribute verbatim or modified copies of
    this license document, and changing it is allowed as long as the name is changed.
    
    DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
    
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
    
       0. You just DO WHAT THE FUCK YOU WANT TO.


### Note on the license

It's highly likely that the WTFPL is completely incompatible with the
GPL, for what should be fairly obvious reasons.  To that, I say:

**SUE ME, RMS!**