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
|
#+title: Emacs Configuration
* Early Setup
Force the use of a =custom.el= file instead of appending to =init.el=.
#+begin_src emacs-lisp
(setq custom-file (concat user-emacs-directory "custom.el"))
(when (file-exists-p custom-file)
(load custom-file))
#+end_src
Make Emacs use the correct =PATH= variable as macOS fails to load the =PATH= variable from my login shell.
#+begin_src emacs-lisp
(defun jj/set-exec-path-from-shell-PATH ()
"Load the login shell's PATH variable manually because macOS doesn't behave well."
(interactive)
(let ((path-from-shell (replace-regexp-in-string
"[ \t\n]*$" "" (shell-command-to-string
"$SHELL --login -c 'echo $PATH'"))))
(setenv "PATH" path-from-shell)
(setq exec-path (split-string path-from-shell path-separator))))
(jj/set-exec-path-from-shell-PATH)
#+end_src
Suppress native compilation warnings and errors. Native compilation seems to be a little broken on macOS and the warnings are just annoying.
#+begin_src emacs-lisp :tangle yes
(setq native-comp-async-report-warnings-errors 'silent)
#+end_src
Bootstrap package management. I use =straight= with =use-package= to allow declarative package management and include =git= repositories in addition to =elpa= / =melpa=.
#+begin_src emacs-lisp
(defvar bootstrap-version)
(let ((bootstrap-file
(expand-file-name
"straight/repos/straight.el/bootstrap.el"
(or (bound-and-true-p straight-base-dir)
user-emacs-directory)))
(bootstrap-version 7))
(unless (file-exists-p bootstrap-file)
(with-current-buffer
(url-retrieve-synchronously
"https://raw.githubusercontent.com/radian-software/straight.el/develop/install.el"
'silent 'inhibit-cookies)
(goto-char (point-max))
(eval-print-last-sexp)))
(load bootstrap-file nil ':nomessage))
(straight-use-package 'use-package)
(setq straight-use-package-by-default t)
#+end_src
* Appearance
Set up fonts. I use Source Code Pro (Nerd Font) for monospace and Computer Modern for variable width.
#+begin_src emacs-lisp
(defvar jj/mono-font)
(defvar jj/var-font)
(pcase system-type
(`gnu/linux
(setq jj/mono-font "SauceCodePro Nerd Font-11"
jj/var-font "CMU Serif-14"))
(`darwin
(setq jj/mono-font "SauceCodePro Nerd Font-14:weight=thin"
jj/var-font "CMU Serif-18")))
(add-to-list 'default-frame-alist
`(font . ,jj/mono-font))
(custom-set-faces
`(variable-pitch ((t :font ,jj/var-font)))
`(fixed-pitch ((t :font ,jj/mono-font))))
#+end_src
This block is the reason I use =straight= rather than just =use-package=. I have a custom Emacs theme that comes from my own fork of =doom-themes=. I also use =doom-modeline= and =nerd-icons= for a nicer-looking user interface and remove the title bar from the window along with any other unnecessary elements from the screen. =dired= is modified to use =nerd-icons= and colours.
#+begin_src emacs-lisp
(use-package doom-themes
:straight
(doom-themes :type git
:host github
:repo "doomemacs/themes"
:fork
(:host github
:repo "JacobJanzen/emacs-doom-themes"))
:config
(setq doom-themes-enable-bold t
doom-themes-enable-italic t)
(load-theme 'doom-pink t)
(doom-themes-org-config))
(use-package doom-modeline
:init
(doom-modeline-mode 1))
(use-package nerd-icons)
(use-package nerd-icons-dired
:after
(nerd-icons)
:hook
(dired-mode . nerd-icons-dired-mode))
(use-package nerd-icons-completion
:config
(nerd-icons-completion-mode))
(use-package diredfl
:init
(diredfl-global-mode 1))
;;(add-to-list 'default-frame-alist '(undecorated . t))
(scroll-bar-mode -1)
(tool-bar-mode -1)
(menu-bar-mode -1)
#+end_src
Disable the default startup screen so Emacs starts in the =scratch= buffer and also defaults to an empty =scratch= buffer.
#+begin_src emacs-lisp
(setq inhibit-startup-screen t
initial-scratch-message nil)
#+end_src
Tell Emacs to use line numbers by default.
#+begin_src emacs-lisp
(global-display-line-numbers-mode 1)
#+end_src
Configure Emacs to default to spaces over tabs and use a width of 4 by default.
#+begin_src emacs-lisp
(setq-default indent-tabs-mode nil)
(setq tab-width 4
c-basic-offset tab-width)
#+end_src
Install and configure =visual-fill-column= to make some file types display with a narrow window centred in the frame.
#+begin_src emacs-lisp
(defun jj/run-visual-line-mode ()
"run visual-line-mode"
(visual-line-mode)
(visual-fill-column-mode)
(setq visual-fill-column-width 100
visual-fill-column-center-text t))
(use-package visual-fill-column
:hook
(org-mode . jj/run-visual-line-mode)
(markdown-mode . jj/run-visual-line-mode)
:config
(setq visual-fill-column-width 100
visual-fill-column-center-text t))
#+end_src
* Behaviour
Make Emacs scroll one line at a time instead of big jumps.
#+begin_src emacs-lisp
(setq scroll-conservatively most-positive-fixnum)
#+end_src
Make Emacs delete trailing whitspace on save. This does not happen in =markdown-mode= which sometimes needs trailing whitespace.
#+begin_src emacs-lisp
(add-hook 'before-save-hook
(lambda ()
(unless (eql (with-current-buffer (current-buffer) major-mode)
'markdown-mode)
(delete-trailing-whitespace))))
#+end_src
Make Emacs create directories if they don't exist if the user selects that answer.
#+begin_src emacs-lisp
(add-to-list 'find-file-not-found-functions
(lambda ()
(let ((parent-directory (file-name-directory buffer-file-name)))
(when (and (not (file-exists-p parent-directory))
(y-or-n-p (format "Directory `%s' does not exist! Create it?" parent-directory)))
(make-directory parent-directory t)))))
#+end_src
Disable the creation of backup files which pollute the file system.
#+begin_src emacs-lisp
(setq make-backup-files nil)
#+end_src
Make PDFs save where in the document it was last.
#+begin_src emacs-lisp
(use-package saveplace-pdf-view
:config
(save-place-mode 1))
#+end_src
* Tools
Configure =dumb-jump= for better lookup.
#+begin_src emacs-lisp
(use-package dumb-jump
:init
(add-hook 'xref-backend-functions #'dumb-jump-xref-activate))
#+end_src
Configure and install =magit= as a =git= front end.
#+begin_src emacs-lisp
(use-package magit)
#+end_src
Install a better PDF viewer than =DocView=.
#+begin_src emacs-lisp
(use-package pdf-tools
:config
(pdf-tools-install)
:hook
(pdf-view-mode . (lambda () (display-line-numbers-mode -1)))
:init
(add-hook 'TeX-after-compilation-finished-functions #'TeX-revert-document-buffer)
:config
(setq TeX-view-program-selection '((output-pdf "PDF Tools"))
TeX-view-program-list '(("PDF Tools" TeX-pdf-tools-sync-view))
TeX-source-correlate-start-server t))
#+end_src
Install and configure =fzf= to be used as a fuzzy finder.
#+begin_src emacs-lisp
(use-package fzf
:bind
("C-c C-f" . fzf)
:config
(setq fzf/args "-x --color 16 --print-query --margin=1,0 --no-hscroll"
fzf/executable "fzf"
fzf/git-grep-args "-i --line-number %s"
fzf/grep-command "grep -nrH"
fzf/position-bottom nil
fzf/window-height 15))
#+end_src
Install and configure =vterm= as a terminal emulator in Emacs.
#+begin_src emacs-lisp
(use-package vterm
:bind
("C-c v" . vterm))
#+end_src
Install =company= for completions. It is configured to start with no delay immediately after the first key press. =vertico= is used as a front end for completions. =orderless= is used to allow searching in any portion of a string and =marginalia= gives descriptions of items in the list.
#+begin_src emacs-lisp
(use-package company
:config
(add-hook 'after-init-hook 'global-company-mode)
(setq company-idle-delay 0
company-minimum-prefix-length 1
company-selection-wrap-around t))
(use-package vertico
:custom
(vertico-cycle t)
:init
(vertico-mode 1))
(use-package orderless
:custom
(completion-styles '(orderless basic))
(completion-category-overrides '((file (styles basic partial-completion)))))
(use-package marginalia
:bind
(:map minibuffer-local-map
("M-A" . marginalia-cycle))
:init
(marginalia-mode 1))
#+end_src
Set up =flycheck= and =flyspell= for syntax and spell checking respectively.
#+begin_src emacs-lisp
(use-package flycheck
:config
(add-hook 'after-init-hook #'global-flycheck-mode))
(use-package flyspell
:hook
(text-mode . flyspell-mode))
(use-package flyspell-correct
:after flyspell
:bind (:map flyspell-mode-map ("C-;" . flyspell-correct-wrapper)))
#+end_src
Install =yasnippet= for managing snippets and =yasnippet-snippets= for a collection of useful snippets.
#+begin_src emacs-lisp
(use-package yasnippet
:init
(yas-global-mode 1)
:bind
("C-c s" . yas-insert-snippet))
(use-package yasnippet-snippets)
#+end_src
Install =apheleia= and =clang-format= to automatically format code on save.
#+begin_src emacs-lisp
(use-package apheleia
:init (apheleia-global-mode 1))
(use-package clang-format)
#+end_src
Configure and install =elfeed= to serve as an =rss= feed reader. It stores the feed [[./feed.org.org][here]].
#+begin_src emacs-lisp
(use-package elfeed
:bind
("C-c e f" . elfeed)
("C-c e u" . elfeed-update))
(use-package elfeed-goodies
:after
elfeed
:config
(elfeed-goodies/setup))
(use-package elfeed-org
:config
(elfeed-org)
(setq rmh-elfeed-org-files (list "~/.config/emacs/feed.org")))
#+end_src
Set up =deft= for quick notes.
#+begin_src emacs-lisp
(use-package deft
:bind
("C-c d" . deft)
:config
(setq deft-directory "~/notes/"
deft-default-extension "org"))
#+end_src
* Languages
Configure =org-mode=. I use =~/org= as my =org= directory and hide emphasis markers because it's much easier to read that way. I enable =org-crypt= to allow reading and writing encrypted =org= files. I also replace bullets in bulleted lists with nicer looking icons. I configure faces to default to variable-width font, but switching to monospace where it is necessary. Finally, I use =visual-fill-column= to make =org= files display with a relatively narrow window centred in the frame.
#+begin_src emacs-lisp
(use-package org
:hook
(org-mode . (lambda ()
(variable-pitch-mode)
(display-line-numbers-mode -1)))
:config
(org-crypt-use-before-save-magic)
(setq org-directory "~/org"
org-hide-emphasis-markers t
org-format-latex-options (plist-put org-format-latex-options :scale 2.0)
org-return-follows-link t
org-tags-exclude-from-inheritance '("crypt")
org-crypt-key nil
auto-save-default nil)
(font-lock-add-keywords 'org-mode
'(("^ *\\([-]\\) "
(0 (prog1 () (compose-region (match-beginning 1) (match-end 1) "•"))))))
:custom-face
(org-block ((t :font ,jj/mono-font)))
(org-code ((t :font ,jj/mono-font (:inherit (shadow)))))
(org-document-info-keyword ((t :font ,jj/mono-font (:inherit (shadow)))))
(org-meta-line ((t :font ,jj/mono-font (:inherit (font-lock-comment-face)))))
(org-verbatim ((t :font ,jj/mono-font (:inherit (shadow)))))
(org-table ((t :font ,jj/mono-font (:inherit (shadow)))))
(org-document-title ((t (:inherit title :height 2.0 :underline nil))))
(org-level-1 ((t (:inherit outline-1 :weight bold :height 1.75))))
(org-level-2 ((t (:inherit outline-2 :weight bold :height 1.5))))
(org-level-3 ((t (:inherit outline-3 :weight bold :height 1.25))))
(org-level-4 ((t (:inherit outline-4 :weight bold :height 1.1))))
(org-level-5 ((t (:inherit outline-5 :height 1.1))))
(org-level-6 ((t (:inherit outline-6)))))
#+end_src
Install =cmake-mode=.
#+begin_src emacs-lisp
(use-package cmake-mode)
#+end_src
Install =go-mode= and tools for =go= source code. Namely, =go-eldoc= gets documentation for =go= variables, functions, and arguments, =go-gen-tests= automatically generates tests for =go= code, and =go-guru= helps with refactoring =go= code.
#+begin_src emacs-lisp
(use-package go-mode)
(use-package go-eldoc
:hook
(go-mode . go-eldoc-setup))
(use-package go-gen-test)
(use-package go-guru
:hook
(go-mode . go-guru-hl-identifier-mode))
#+end_src
Install tools for LaTeX. Namely, =auctex= for better integration with Emacs and =cdlatex= for environment and macro insertion.
#+begin_src emacs-lisp
(use-package auctex
:hook
(LaTeX-mode . (lambda () (put 'LaTeX-mode 'eglot-language-id "latex"))))
(use-package cdlatex
:hook
(LaTeX-mode . turn-on-cdlatex))
#+end_src
Install tools for Emacs Lisp. Namely =parinfer-rust-mode= which handles parentheses nicely in Emacs Lisp.
#+begin_src emacs-lisp :tangle yes
(use-package parinfer-rust-mode
:hook
(emacs-lisp-mode . parinfer-rust-mode)
:init
(setq parinfer-rust-auto-download t))
#+end_src
Install =lua-mode=.
#+begin_src emacs-lisp
(use-package lua-mode)
#+end_src
Configure how Markdown is displayed (default to variable-width font and use monospace where necessary) and installs =markdown-mode=.
#+begin_src emacs-lisp
(use-package markdown-mode
:hook
(markdown-mode . (lambda ()
(variable-pitch-mode)
(display-line-numbers-mode -1)))
:config
(setq markdown-hide-markup t)
:custom-face
(markdown-header-face ((t :font ,jj/var-font :weight bold)))
(markdown-header-face-1 ((t (:inherit markdown-header-face :height 2.0))))
(markdown-header-face-2 ((t (:inherit markdown-header-face :height 1.75))))
(markdown-header-face-3 ((t (:inherit markdown-header-face :height 1.5))))
(markdown-header-face-4 ((t (:inherit markdown-header-face :height 1.25))))
(markdown-header-face-5 ((t (:inherit markdown-header-face :height 1.1))))
(markdown-header-face-6 ((t (:inherit markdown-header-face :height 1.1))))
(markdown-blockquote-face ((t :font ,jj/var-font)))
(markdown-code-face ((t :font ,jj/mono-font)))
(markdown-html-attr-name-face ((t :font ,jj/mono-font)))
(markdown-html-attr-value-face ((t :font ,jj/mono-font)))
(markdown-html-entity-face ((t :font ,jj/mono-font)))
(markdown-html-tag-delimiter-face ((t :font ,jj/mono-font)))
(markdown-html-tag-name-face ((t :font ,jj/mono-font)))
(markdown-html-comment-face ((t :font ,jj/mono-font)))
(markdown-header-delimiter-face ((t :font ,jj/mono-font)))
(markdown-hr-face ((t :font ,jj/mono-font)))
(markdown-inline-code-face ((t :font ,jj/mono-font)))
(markdown-language-info-face ((t :font ,jj/mono-font)))
(markdown-language-keyword-face ((t :font ,jj/mono-font)))
(markdown-link-face ((t :font ,jj/mono-font)))
(markdown-markup-face ((t :font ,jj/mono-font)))
(markdown-math-face ((t :font ,jj/mono-font)))
(markdown-metadata-key-face ((t :font ,jj/mono-font)))
(markdown-metadata-value-face ((t :font ,jj/mono-font)))
(markdown-missing-link-face ((t :font ,jj/mono-font)))
(markdown-plain-url-face ((t :font ,jj/mono-font)))
(markdown-reference-face ((t :font ,jj/mono-font)))
(markdown-table-face ((t :font ,jj/mono-font)))
(markdown-url-face ((t :font ,jj/mono-font))))
#+end_src
Install =nix-mode=.
#+begin_src emacs-lisp
(use-package nix-mode
:mode
"\\.nix\\'")
#+end_src
Install =yaml-mode=.
#+begin_src emacs-lisp :tangle yes
(use-package yaml-mode)
#+end_src
Set up =eglot= to run on languages that have been configured.
#+begin_src emacs-lisp
(global-set-key (kbd "C-c r") 'eglot-rename)
(global-set-key (kbd "C-c a") 'eglot-code-actions)
(use-package tree-sitter)
(use-package tree-sitter-langs)
(dolist (lang-hook '(sh-mode-hook
c-mode-hook
c++-mode-hook
cc-mode-hook
cmake-mode-hook
html-mode-hook
css-mode-hook
js-json-mode-hook
js-mode-hook
python-mode-hook
go-mode-hook
lua-mode-hook
markdown-mode-hook
tex-mode-hook
LaTeX-mode-hook
yaml-mode-hook
nix-mode-hook))
(add-hook lang-hook (lambda ()
(eglot-ensure)
(tree-sitter-mode 1)
(tree-sitter-hl-mode 1))))
#+end_src
|