#+TITLE: Dotfiles #+AUTHOR: Christopher James Hayward #+EMAIL: chris@chrishayward.xyz #+ROAM_KEY: https://github.com/chayward1/dotfiles #+begin_example ^^ @@@@@@@@@ ^^ ^^ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@ ^^ @@@@@@@@@@@@@@@@@@@@ ~~~~ ~~ ~~~~~ ~~~~~~~~ ~~ &&&&&&&&&&&&&&&&&&&& ~~~~~~~ ~~~~~~~~~~~ ~~~ ~ ~~ ~ ~ ~~~~~~~~~~~~~~~~~~~~ ~ ~~ ~~ ~ ~ ~~ ~~ ~~ ~~ ~~~~~~~~~~~~~ ~~~~ ~ ~~~ ~ ~~~ ~ ~~ ~ ~~ ~ ~ ~~~~~~ ~~ ~~~ ~~ ~ ~~ ~~ ~ ~ ~ ~ ~ ~ ~~ ~~~~~~ ~ ~~ ~ ~~ ~ ~ ~ ~ ~~ ~ ~ #+end_example Immutable GNU Emacs dotfiles, inspired by Doom, built for Liberty. + 100% Literate + 100% Immutable + 100% Reproducible #+begin_src emacs-lisp :tangle ~/.local/source/dotfiles/init.el :results silent (defun dotfiles/tangle (dir) "Recursively tangle the Org files within a directory." (interactive) (let ((org-files (directory-files-recursively dir "org"))) (dolist (f org-files) (org-babel-tangle-file f)))) #+end_src * Core :PROPERTIES: :header-args: :tangle ~/.local/source/dotfiles/init.el :results silent :END: Emacs creates a lot of files relative to ~user-emacs-directory~, these files are not part of this immutable configuration and do not belong in the emacs directory. #+begin_src emacs-lisp (defvar dotfiles/home user-emacs-directory) #+end_src How can we solve this issue? #+begin_src emacs-lisp (defvar dotfiles/cache "~/.cache/emacs") #+end_src Shortly after initialization, before most packages are loaded, we change the value to ~dotfiles/cache~. I elaborate more on the technique in my post [[https://chrishayward.xyz/posts/immutable_emacs/][Immutable Emacs]]. #+begin_src emacs-lisp (setq user-emacs-directory dotfiles/cache) #+end_src Because this project uses version-control, we can disable more unwanted features: + Lock files + Backup files #+begin_src emacs-lisp (setq create-lockfiles nil make-backup-files nil) #+end_src ** Packages Download and install packages using [[https://github.com/raxod502/straight.el][straight.el]], a functional package manager that integrates with =use-package=, giving us more control over where packages are sourced from. + Use the development branch + Integrate with ~use-package~ Apply the configurations prior to bootstrapping the package manager, by setting (writing) to the variables that =straight= will ultimately read from. #+begin_src emacs-lisp (setq straight-repository-branch "develop" straight-use-package-by-default t) #+end_src Bootstrap the package manager, downloading, installing, or configuring depending on the state of the configuration. All packages are downloaded and built from source, and can be pinned to specific git commit hashes. #+begin_src emacs-lisp (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 "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)) #+end_src Complete the integration with ~use-package~ by installing it with =straight=. #+begin_src emacs-lisp (straight-use-package 'use-package) #+end_src ** Cleanup Despite having our *stateful* and *immutable* configurations seperate, it's good practice to make efforts to reduce the trash created by Emacs. Install [[https://github.com/emacscollective/no-littering][no-littering]] to reduce the files created by Emacs. #+begin_src emacs-lisp (use-package no-littering) #+end_src Emacs' default user interface is horrendous, but with less than 10 lines of code we can change that. #+begin_src emacs-lisp (setq inhibit-startup-message t) (global-prettify-symbols-mode) (scroll-bar-mode -1) (menu-bar-mode -1) (tool-bar-mode -1) (tooltip-mode -1) #+end_src ** Babel *Organize your plain life in plain text* [[https://orgmode.org][Org-mode]] is one of the hallmark features of Emacs, and provides the basis for my Literate Programming platform. It's essentially a markdown language with rich features for project management, scheduling, development, and writing. It's hard to convey everything within its capabilities. + [[https://orgmode.org/worg/org-contrib/babel/languages/index.html][Babel languages]] + [[https://orgmode.org/manual/Structure-Templates.html][Structure templates]] #+begin_src emacs-lisp (use-package org :hook (org-mode . (lambda () (org-indent-mode) (visual-line-mode 1) (variable-pitch-mode 1))) :config (setq org-ellipsis " ▾" org-log-done 'time org-log-into-drawer t org-src-preserve-indentation t) (org-babel-do-load-languages 'org-babel-load-languages '((shell . t) (python . t) (emacs-lisp . t))) (require 'org-tempo) (add-to-list 'org-structure-template-alist '("s" . "src")) (add-to-list 'org-structure-template-alist '("q" . "quote")) (add-to-list 'org-structure-template-alist '("e" . "example")) (add-to-list 'org-structure-template-alist '("sh" . "src shell")) (add-to-list 'org-structure-template-alist '("py" . "src python")) (add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp"))) #+end_src ** Keys Make the =ESC= key quit (most) prompts, instead of the default =C-g=. #+begin_src emacs-lisp (global-set-key (kbd "") 'keyboard-escape-quit) #+end_src Functionality like =completion= and =hints= can be delayed to avoid popups for common manuevers. Adjust this value to your personal taste. #+begin_src emacs-lisp (defvar dotfiles/idle 0.0) #+end_src Download [[https://github.com/justbur/emacs-which-key][which-key]], a package that displays the current incomplete keybinding input in a mini-buffer, showing available completion options. #+begin_src emacs-lisp (use-package which-key :diminish which-key-mode :init (which-key-mode) :config (setq which-key-idle-delay dotfiles/idle)) #+end_src Avoid the infamous *Emacs pinky* by binding =SPC= as a leader key, utilizing the thumb instead of the weaker pinky finger. You may change this value if you want to use something else. #+begin_src emacs-lisp (defvar dotfiles/leader-key "SPC") #+end_src Implement the *leader* key mentioned above using [[https://github.com/noctuid/general.el][general.el]], letting us easily configure prefixed keybindings in a much cleaner manner than the default methods. #+begin_src emacs-lisp (use-package general :config (general-create-definer dotfiles/leader :states '(normal motion) :keymaps 'override :prefix dotfiles/leader-key)) #+end_src Use [[https://github.com/abo-abo/hydra][hydra]] for transient keybindings sharing a common prefix. #+begin_src emacs-lisp (use-package hydra) #+end_src *** Evil After a few hour with =vim= I knew it was game over, I cannot even think of another way I would feel comfortable editing text. Luckily, there exist packages to emulate this within Emacs. https://evil.readthedocs.io/en/latest/index.html + Extendable VI layer for Emacs + Disable default keybindings #+begin_src emacs-lisp (use-package evil :init (setq evil-want-integration t evil-want-keybinding nil) :config (evil-mode 1)) #+end_src https://github.com/emacs-evil/evil-collection + Community keybindings for =evil-mode= #+begin_src emacs-lisp (use-package evil-collection :after evil :config (evil-collection-init)) #+end_src https://github.com/redguardtoo/evil-nerd-commenter + Toggle comments with =M-;= #+begin_src emacs-lisp (use-package evil-nerd-commenter :bind ("M-;" . evilnc-comment-or-uncomment-lines)) #+end_src *** Shortcuts Again cherry picked from =Doom=, I want to continue utilizing the muscle memory I have developed from a year of mainlining the framework. + Close buffers with =SPC c= + Find files with =SPC . (period)= + Switch buffers with =SPC , (comma)= #+begin_src emacs-lisp (dotfiles/leader "." '(find-file :which-key "Files") "," '(switch-to-buffer :which-key "Buffers") "c" '(kill-buffer-and-window :which-key "Close")) #+end_src **** Quit Quit emacs with =SPC q=. + Saving =q= + Without =w= + Frame (daemon) =f= #+begin_src emacs-lisp (dotfiles/leader "q" '(:ignore t :which-key "Quit") "qq" '(save-buffers-kill-emacs :which-key "Save") "qw" '(kill-emacs :which-key "Now") "qf" '(delete-frame :which-key "Frame")) #+end_src **** Windows Window management with =SPC w=. + Swap with =w= + Close with =c= + Motions with =h,j,k,l= + Split with =s + = #+begin_src emacs-lisp (dotfiles/leader "w" '(:ignore t :which-key "Window") "ww" '(window-swap-states :which-key "Swap") "wc" '(delete-window :which-key "Close") "wh" '(windmove-left :which-key "Left") "wj" '(windmove-down :which-key "Down") "wk" '(windmove-up :which-key "Up") "wl" '(windmove-right :which-key "Right") "ws" '(:ignore t :which-key "Split") "wsj" '(split-window-below :which-key "Down") "wsl" '(split-window-right :which-key "Right")) #+end_src * Editor :PROPERTIES: :header-args: :tangle ~/.local/source/dotfiles/init.el :results silent :END: *Bring Emacs out of the eighties* ** Git Another hallmark feature is [[https://github.com/magit/magit][Magit]], a complete git porcelain within Emacs. #+begin_src emacs-lisp (use-package magit :custom (magit-display-buffer-function #'magit-display-buffer-same-window-except-diff-v1)) #+end_src Work directly with github issues / pull requests using [[https://github.com/magit/forge][Forge]]. + Requires a valid ~$GITHUB_TOKEN~ #+begin_src emacs-lisp (use-package forge) #+end_src Open the *status* page for the current repository with =SPC g=. #+begin_src emacs-lisp (dotfiles/leader "g" '(magit-status :which-key "Magit")) #+end_src ** Shell While not a traditional terminal emulator, =eshell= provides me with all of the functionality I expect and require from one. Some users may be left wanting more, I would recommend they look into =vterm=. https://github.com/zwild/eshell-prompt-extras + Enable lambda shell prompt #+begin_src emacs-lisp (use-package eshell-prompt-extras :config (setq eshell-highlight-prompt nil eshell-prompt-function 'epe-theme-lambda)) #+end_src Open an =eshell= buffer with =SPC e=. #+begin_src emacs-lisp (dotfiles/leader "e" '(eshell :which-key "Shell")) #+end_src ** Files Emacs' can feel more modern when icon-fonts are installed and prioritized. I feel that this makes navigation of folders much faster, given that file types may be quickly identified by their corresponding icons. https://github.com/domtronn/all-the-icons.el + Collects various icon fonts #+begin_src emacs-lisp (use-package all-the-icons) #+end_src https://github.com/jtbm37/all-the-icons-dired + Integration with dired #+begin_src emacs-lisp (use-package all-the-icons-dired :hook (dired-mode . all-the-icons-dired-mode)) #+end_src When opening =dired=, I don't want to have to press =RET= twice to navigate to the current directory. This can be avoided with ~dired-jump~, included in the =dired-x= package shipped with =dired=. #+begin_src emacs-lisp (require 'dired-x) #+end_src By default =dired= will create a new buffer everytime you press =RET= over a directory. In my workflow this leads to many unwanted =dired= buffers that have to be cleaned up manually. [[https://github.com/crocket/dired-single][Dired-single]] lets us reuse the same dired buffer. + Move up a directory with =h= + Open a single buffer with =l= #+begin_src emacs-lisp (use-package dired-single :config (evil-collection-define-key 'normal 'dired-mode-map "h" 'dired-single-up-directory "l" 'dired-single-buffer)) #+end_src Open a dired buffer with =SPC d=. #+begin_src emacs-lisp (dotfiles/leader "d" '(dired-jump :which-key "Dired")) #+end_src ** Fonts Configure the system font with a single ~font-family~ and define the size, of which variations to the font size are relative to this value. #+begin_src emacs-lisp (defvar dotfiles/font "Fira Code") (defvar dotfiles/font-size 96) #+end_src Write out to all *3* of Emacs' default font faces. #+begin_src emacs-lisp (set-face-attribute 'default nil :font dotfiles/font :height dotfiles/font-size) (set-face-attribute 'fixed-pitch nil :font dotfiles/font :height dotfiles/font-size) (set-face-attribute 'variable-pitch nil :font dotfiles/font :height dotfiles/font-size) #+end_src Define a transient keybinding for scaling the text. #+begin_src emacs-lisp (defhydra hydra-text-scale (:timeout 4) "Scale" ("j" text-scale-increase "Increase") ("k" text-scale-decrease "Decrease") ("f" nil "Finished" :exit t)) #+end_src Increase the font size in buffers with =SPC f=. + Increase =j= + Decrease =k= + Finish =f= #+begin_src emacs-lisp (dotfiles/leader "f" '(hydra-text-scale/body :which-key "Font")) #+end_src ** Lines Relative line numbers are important when using =VI= emulation keys. You can prefix most commands with a *number*, allowing you to jump up / down by a line count. #+begin_example 5: 4: 3: 2: 1: 156: << CURRENT LINE >> 1: 2: 3: 4: 5: #+end_example https://github.com/emacsmirror/linum-relative + Integrate with ~display-line-numbers-mode~ for performance #+begin_src emacs-lisp (use-package linum-relative :init (setq linum-relative-backend 'display-line-numbers-mode) :config (linum-relative-global-mode)) #+end_src https://github.com/Fanael/rainbow-delimiters + Colourize nested parenthesis #+begin_src emacs-lisp (use-package rainbow-delimiters :hook (prog-mode . rainbow-delimiters-mode)) #+end_src ** Themes Bring Emacs' out of the eighties by cherry picking a few modules from =Doom=. https://github.com/hlissner/emacs-doom-themes + Modern colour themes #+begin_src emacs-lisp (use-package doom-themes :init (load-theme 'doom-moonlight t)) #+end_src Load a theme with =SPC t=. #+begin_src emacs-lisp (dotfiles/leader "t" '(load-theme t nil :which-key "Theme")) #+end_src https://github.com/seagle0128/doom-modeline + Elegant status bar / modeline #+begin_src emacs-lisp (use-package doom-modeline :init (doom-modeline-mode 1) :custom ((doom-modeline-height 16))) #+end_src * Writing :PROPERTIES: :header-args: :tangle ~/.local/source/dotfiles/init.el :results silent :END: I am using [[https://orgmode.org][Org-mode]] extensively for writing projects for different purposes. Improvements beyond what are required for my Literate Programming platform include: [[https://github.com/integral-dw/org-superstar-mode][Org-superstar-mode]] for making headline stars more *super*. #+begin_src emacs-lisp (use-package org-superstar :hook (org-mode . org-superstar-mode)) #+end_src ** Mail #+begin_src emacs-lisp (add-to-list 'load-path "/usr/share/emacs/site-lisp/mu4e") #+end_src #+begin_src emacs-lisp (use-package mu4e :config (setq mu4e-change-filenames-when-moving t mu4e-update-interval (* 5 60) ;; Every 5 minutes. mu4e-get-mail-command "mbsync -a" mu4e-maildir "~/.cache/mail" mu4e-compose-signature (concat "Chris Hayward\n" "https://chrishayward.xyz\n")) ;; Ensure plain text scales for all devices. (setq mu4e-compose-format-flowed t) ;; GPG signing key for outbound mail. (setq mml-secure-openpgp-signers '("37AB1CB72B741E478CA026D43025DCBD46F81C0F")) (add-hook 'message-send-hook 'mml-secure-message-sign-pgpmime) (setq message-send-mail-function 'smtpmail-send-it) ;; Configure mail account(s). (setq mu4e-contexts (list ;; Main ;; chris@chrishayward.xyz (make-mu4e-context :name "Main" :match-func (lambda (msg) (when msg (string-prefix-p "/Main" (mu4e-message-field msg :maildir)))) :vars '((user-full-name . "Christopher James Hayward") (user-mail-address . "chris@chrishayward.xyz") (smtpmail-smtp-server . "mail.chrishayward.xyz") (smtpmail-smtp-service . 587) (smtpmail-stream-type . starttls)))))) #+end_src #+begin_src emacs-lisp (dotfiles/leader "m" '(mu4e :which-key "Mail")) #+end_src ** Brain [[https://github.com/org-roam/org-roam][Org-roam]] is a rudimentary roam replica built on =Org mode=. #+begin_src emacs-lisp (use-package org-roam :hook (after-init . org-roam-mode) :custom (org-roam-directory "~/.local/source/brain")) #+end_src [[https://github.com/org-roam/org-roam-server][Org-roam-server]] is a web application that visualizes the =Org roam= database, available when Emacs' running at [[http://localhost:8080][localhost:8080]]. #+begin_src emacs-lisp (use-package org-roam-server :hook (org-roam-mode . org-roam-server-mode)) #+end_src Configure keybindings behind =SPC r=. + Find with =f= + Buffer with =b= + Capture with =c= + Dailies with =d= #+begin_src emacs-lisp (dotfiles/leader "r" '(:ignore t :which-key "Roam") "rf" '(org-roam-find-file :which-key "Find") "rb" '(org-roam-buffer-toggle-display :which-key "Buffer") "rc" '(org-roam-capture :which-key "Capture") "rd" '(:ignore t :which-key "Dailies") "rdd" '(org-roam-dailies-find-date :which-key "Date") "rdt" '(org-roam-dailies-find-today :which-key "Today") "rdm" '(org-roam-dailies-find-tomorrow :which-key "Tomorrow") "rdy" '(org-roam-dailies-find-yesterday :which-key "Yesterday")) #+end_src Configure the default capture template for new topics. #+begin_src emacs-lisp (setq org-roam-capture-templates '(("d" "Default" plain (function org-roam-capture--get-point) "%?" :file-name "${slug}" :head "#+TITLE: ${title}\n" :unnarrowed t))) #+end_src Configure the default capture template for daily entries. #+begin_src emacs-lisp (setq org-roam-dailies-capture-templates '(("d" "Default" entry (function org-roam-capture--get-point) "* %?" :file-name "daily/%<%Y-%m-%d>" :head "#+TITLE: %<%Y-%m-%d>\n"))) #+end_src ** Blogging I use [[https://gohugo.io][Hugo]] for my personal [[https://chrishayward.xyz][website]], which I write in =Org-mode= before compiling to =hugo-markdown=. [[https://github.com/kaushalmodi/ox-hugo][Ox-hugo]], configured for =one-post-per-file= is my technique for managing my blog. #+begin_src emacs-lisp (use-package ox-hugo :after ox) #+end_src Creaate a capture template for blog posts in the =posts= sub directory. #+begin_src emacs-lisp (add-to-list 'org-roam-capture-templates '("b" "Blogging" plain (function org-roam-capture--get-point) "%?" :file-name "posts/${slug}" :head "#+TITLE: ${title}\n#+HUGO_BASE_DIR: ~/.local/source/website\n#+HUGO_SECTION: posts\n")) #+end_src ** Agenda Configure agenda sources. + Dailies ~~/.local/source/brain/daily/~ + Secrets ~~/.local/source/secrets/org/~ #+begin_src emacs-lisp (setq org-agenda-files '("~/.local/source/brain/daily/" "~/.local/source/secrets/org/")) #+end_src Open an agenda buffer with =SPC a=. #+begin_src emacs-lisp (dotfiles/leader "a" '(org-agenda :which-key "Agenda")) #+end_src ** Screencasts Create screencasts with =one-frame-per-action= GIF recording via [[https://github.com/takaxp/emacs-gif-screencast][emacs-gif-screencast]]. + Can be paused / resumed + High quality images + Optimized size It requires the installation of ~scrot~ and ~convert~ from the =ImageMagick= library. #+begin_src emacs-lisp (use-package gif-screencast :custom (gif-screencast-output-directory "~/.local/source/brain/screen/")) #+end_src Screencast controls behind =SPC p=. + Start / stop with =s= + Pause with =p= #+begin_src emacs-lisp (dotfiles/leader "p" '(:ignore t :which-key "Screencast") "ps" '(gif-screencast-start-or-stop :which-key "Start / Stop") "pp" '(gif-screencast-toggle-pause :which-key "Pause")) #+end_src ** Presentations Produce high quality presentations that work anywhere with =HTML/JS= and the [[https://revealjs.com][Reveal.js]] package. [[https://github.com/hexmode/ox-reveal][Ox-reveal]], configured to use a =cdn= allows us to produce ones that are not dependent on a local version of =Reveal.js=. #+begin_src emacs-lisp (use-package ox-reveal :after ox :custom (org-reveal-root "https://cdn.jsdelivr.net/reveal.js/3.9.2/")) #+end_src Create a capture template for presentations stored in the =slides= sub directory. #+begin_src emacs-lisp (add-to-list 'org-roam-capture-templates '("p" "Presentation" plain (function org-roam-capture--get-point) "%?" :file-name "slides/${slug}" :head "#+TITLE: ${title}\n")) #+end_src * Development :PROPERTIES: :header-args: :tangle ~/.local/source/dotfiles/init.el :results silent :END: An IDE like experience (or better) can be achieved in Emacs using two *Microsoft* open source initiatives. Turn Emacs into an *IDE* (or better) with the [[https://microsoft.github.io/language-server-protocol/][Language Server Protocol]], an open source initiative from *Microsoft* for the *VSCode* editor. [[https://emacs-lsp.github.io/lsp-mode/][Lsp-mode]] brings support for language servers into Emacs. #+begin_src emacs-lisp (use-package lsp-mode :custom (gc-cons-threshold 1000000000) (lsp-idle-delay 0.500)) #+end_src https://emacs-lsp.github.io/lsp-ui/ + UI improvements for =lsp-mode= #+begin_src emacs-lisp (use-package lsp-ui :custom (lsp-ui-doc-position 'at-point) (lsp-ui-doc-delay 0.500)) #+end_src ** Passwords Pass makes managing passwords extremely easy, encrypring them in a file structure and providing easy commands for generating, modify, and copying passwords. =password-store.el= provides a wrapper for the functionality within Emacs. #+begin_src emacs-lisp (use-package password-store :custom (password-store-dir "~/.local/source/passwords")) #+end_src ** Debugging Handled through the [[https://microsoft.github.io/debug-adapter-protocol/][Debug Adapter Protocol]], an open source initiative from *Microsoft* for the *VSCode* editor. [[https://emacs-lsp.github.io/dap-mode/][Dap-mode]] adds support for the protocol to Emacs. #+begin_src emacs-lisp (use-package dap-mode) #+end_src ** Completion Text completion framework via =company= aka *Complete Anything*. http://company-mode.github.io/ + Integrate with =lsp-mode= #+begin_src emacs-lisp (use-package company) (use-package company-lsp) #+end_src ** Languages Support for individual languages are implemented here. *** C/C++ Full *IDE* experience for Python within Emacs. + Completion, jumps via =lsp-mode= + Debugging via =dap-mode= Install the =ccls= language server. + https://github.com/MaskRay/ccls #+begin_src emacs-lisp (use-package ccls :hook ((c-mode c++-mode objc-mode cuda-mode) . (lambda () (require 'ccls) (lsp)))) #+end_src *** Python Full *IDE* experience for Python within Emacs. + Completion, jumps via =lsp-mode= + Debugging via =dap-mode= Install the =pyls= language server. #+begin_src shell :tangle no pip install --user "python-language-server[all]" #+end_src https://www.emacswiki.org/emacs/PythonProgrammingInEmacs + Built in mode #+begin_src emacs-lisp (use-package python-mode :hook (python-mode . lsp) :config (require 'dap-python) :custom (python-shell-interpreter "python3") ;; Required if "python" is not python 3. (dap-python-executable "python3") ;; Same as above. (dap-python-debugger 'debugpy)) #+end_src *** Rust Full *IDE* experience for Rust within Emacs. + Completion via =lsp-mode= + Debugging via =dap-mode= https://github.com/brotzeit/rustic + Install via ~lsp-install-server~ #+begin_src shell :tangle no rustup default nightly #+end_src #+begin_src emacs-lisp (use-package rustic) #+end_src *** Go Full *IDE* experience for Rust within Emacs. + Completion via =lsp-mode= + Debugging via =dap-mode= Install the =gopls= language server. #+begin_src sh :tangle no GO111MODULE=on go get golang.org/x/tools/gopls@latest #+end_src #+begin_src emacs-lisp (use-package go-mode :hook (go-mode . lsp)) #+end_src