X-Git-Url: https://git.shemshak.org/~bandali/configs/blobdiff_plain/426cec7a80db7a16d4b820e27996f05a68f99977..e3f803104e43a7a942738bb9437147ee212fec9c:/init.org diff --git a/init.org b/init.org index d8da51c..00a9bf2 100644 --- a/init.org +++ b/init.org @@ -9,10 +9,10 @@ :END: This org file is my literate configuration for GNU Emacs, and is -tangled to [[./init.el][init.el]]. Packages are installed and managed using -[[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of -many different people. Some of the configurations that I can remember -off the top of my head are: +tangled to [[./init.el][init.el]]. Packages are installed and managed using +[[https://github.com/raxod502/straight.el][straight.el]]. Over the years, I've taken inspiration from +configurations of many different people. Some of the configurations +that I can remember off the top of my head are: - [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses straight.el for managing packages @@ -28,26 +28,50 @@ off the top of my head are: I'd like to have a fully reproducible Emacs setup (part of the reason why I store my configuration in this repository) but unfortunately out of the box, that's not achievable with =package.el=, not currently -anyway. So, I've opted to use Borg. For what it's worth, I briefly -experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds -to my init time; which is unacceptable for me: I use Emacs as my -window manager (via EXWM) and coming from bspwm, I'm too used to -having fast startup times. +anyway. So, I've opted to use =straight.el=. I also used Borg for a +few months, but decided to try =straight.el= which allows direct use +of the various package archives. ** Installation To use this config for your Emacs, first you need to clone this repo, -then bootstrap Borg, tell Borg to retrieve package submodules, and -byte-compiled the packages. Something along these lines should work: +then tangle =init.org= into =init.el=, and optionally byte-compile +=init.el=. + +First, clone the repository and =cd= into it: #+begin_src sh :tangle no -git clone https://github.com/aminb/dotfiles ~/.emacs.d +git clone https://git.sr.ht/~bandali/dotfiles ~/.emacs.d cd ~/.emacs.d -make bootstrap-borg -make bootstrap -make build #+end_src +Then, decide if you would like to use a byte-compiled init file, and +set the following variable accordingly: + +#+begin_src emacs-lisp +(defvar a/byte-compiled-init t + "If non-nil, byte-(re)compile init.el on successful tangles.") +#+end_src + +Now, first tangle =init.org=, and only if you chose to have a +byte-compiled init, build init as well: + +#+begin_src sh :tangle no +make tangle-init +make build-init +#+end_src + +If you'd like to use a byte-compiled init, it's important that it be +recompiled whenever =init.el= is generated from an updated =init.org=. +Not only does my setup automatically and asynchronously tangle +=init.org= to =init.el= every time you edit and save =init.org= in GNU +Emacs, it will also invoke =make build-init= if you set +=a/byte-compiled-init= to =t= above, so you wouldn't have to worry +about manually tangling and compiling your init file whenever you +change it. The output of the last byte-compilation in the current +session is kept in a =*compilation*= buffer, which will automatically +be displayed if compilation fails. + * Contents :toc_1:noexport: - [[#about][About]] @@ -215,20 +239,34 @@ hacker. =straight.el= allows me to have a fully reproducible Emacs setup. #+begin_src emacs-lisp -(setq straight-repository-branch "develop") +;; Main engine start... -(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)) +(setq straight-repository-branch "develop" + straight-check-for-modifications '(check-on-save find-when-checking)) + +(defun a/bootstrap-straight () + (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))) + +;; Solid rocket booster ignition... + +(defun a/build-init () + (a/bootstrap-straight) + (byte-compile-file "init.el")) + +(a/bootstrap-straight) + +;; We have lift off! (setq straight-use-package-by-default t) #+end_src @@ -243,38 +281,7 @@ integration, we will define a =use-feature= for plain ole (declare (indent defun)) `(use-package ,name :straight nil -,@args)) -#+end_src - -*** COMMENT Borg - -#+begin_quote -Assimilate Emacs packages as Git submodules -#+end_quote - -[[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In -short, it creates a git submodule in =lib/= for each package, which -can then be managed with the help of Magit or other tools. - -#+begin_src emacs-lisp -(setq user-init-file (or load-file-name buffer-file-name) - user-emacs-directory (file-name-directory user-init-file)) -(add-to-list 'load-path - (expand-file-name "lib/borg" user-emacs-directory)) -(require 'borg) -(borg-initialize) - -;; (require 'borg-nix-shell) -;; (setq borg-build-shell-command 'borg-nix-shell-build-command) - -(with-eval-after-load 'bind-key - (bind-keys - :package borg - ("C-c b A" . borg-activate) - ("C-c b a" . borg-assimilate) - ("C-c b b" . borg-build) - ("C-c b c" . borg-clone) - ("C-c b r" . borg-remove))) + ,@args)) #+end_src *** =use-package= @@ -289,18 +296,20 @@ and without compromising on performance. #+begin_src emacs-lisp (straight-use-package 'use-package) -(if nil ; set to t when need to debug init - (setq use-package-verbose t - use-package-expand-minimally nil - use-package-compute-statistics t - debug-on-error t) +(if nil ; set to t when need to debug init + (progn + (setq use-package-verbose t + use-package-expand-minimally nil + use-package-compute-statistics t + debug-on-error t) + (require 'use-package)) (setq use-package-verbose nil use-package-expand-minimally t)) (setq use-package-always-defer t) #+end_src -*** COMMENT Epkg +*** Epkg #+begin_quote Browse the Emacsmirror package database @@ -311,13 +320,14 @@ database, low-level functions for querying the database, and a =package.el=-like user interface for browsing the available packages. #+begin_src emacs-lisp +(require 'bind-key) (use-package epkg - :defer t + :commands (epkg-list-packages epkg-describe-package) :bind - (("C-c b d" . epkg-describe-package) - ("C-c b p" . epkg-list-packages) - ("C-c b u" . epkg-update)) + (("C-c p e d" . epkg-describe-package) + ("C-c p e p" . epkg-list-packages)) :config + (setq epkg-repository "~/.emacs.d/straight/repos/epkgs/") (eval-when-compile (defvar ivy-initial-inputs-alist)) (with-eval-after-load 'ivy (add-to-list @@ -379,7 +389,8 @@ in my shell. (use-package exec-path-from-shell :defer 1 :init - (setq exec-path-from-shell-check-startup-files nil) + (setq exec-path-from-shell-arguments nil + exec-path-from-shell-check-startup-files nil) :config (exec-path-from-shell-initialize) ;; while we're at it, let's fix access to our running ssh-agent @@ -728,14 +739,18 @@ for this. ** Bindings +Some bindings for functions from built-in GNU Emacs packages: + #+begin_src emacs-lisp -(require 'bind-key) (bind-keys ("C-c a i" . ielm) ("C-c e b" . eval-buffer) ("C-c e r" . eval-region) + ("C-c e i" . emacs-init-time) + ("C-c e u" . emacs-uptime) + ("C-c F m" . make-frame-command) ("C-c F d" . delete-frame) ("C-c F D" . delete-other-frames) @@ -753,6 +768,35 @@ for this. ("s-n" . end-of-buffer)) #+end_src +While at it, let's bind a few for some =straight-*= functions too: + +#+begin_src emacs-lisp +(bind-keys + :prefix-map a/straight-prefix-map + :prefix "C-c p s" + ("u" . straight-use-package) + ("f" . straight-freeze-versions) + ("t" . straight-thaw-versions) + ("P" . straight-prune-build) + ("r" . straight-get-recipe) + ;; M-x ^straight-.*-all$ + ("a c" . straight-check-all) + ("a f" . straight-fetch-all) + ("a m" . straight-merge-all) + ("a n" . straight-normalize-all) + ("a F" . straight-pull-all) + ("a P" . straight-push-all) + ("a r" . straight-rebuild-all) + ;; M-x ^straight-.*-package$ + ("p c" . straight-check-package) + ("p f" . straight-fetch-package) + ("p m" . straight-merge-package) + ("p n" . straight-normalize-package) + ("p F" . straight-pull-package) + ("p P" . straight-push-package) + ("p r" . straight-rebuild-package)) +#+end_src + ** Packages The packages in this section are absolutely essential to my everyday @@ -832,7 +876,7 @@ And here's where my actual Org configurations begin: #+begin_src emacs-lisp (use-feature org - :defer 0.5 + :defer 2 :config (setq org-src-tab-acts-natively t org-src-preserve-indentation nil @@ -844,13 +888,6 @@ And here's where my actual Org configurations begin: org-catch-invisible-edits 'show-and-error org-log-done 'time) (add-to-list 'org-structure-template-alist '("L" . "src emacs-lisp") t) - (font-lock-add-keywords - 'org-mode - '(("[ \t]*\\(#\\+\\(BEGIN\\|END\\|begin\\|end\\)_\\(\\S-+\\)\\)[ \t]*\\([^\n:]*\\)" - (1 '(:foreground "#5a5b5a" :background "#292b2b") t) ; directive - (3 '(:foreground "#81a2be" :background "#292b2b") t) ; kind - (4 '(:foreground "#c5c8c6") t))) ; title - t) :bind (:map org-mode-map ("M-L" . org-insert-last-stored-link)) :hook ((org-mode . org-indent-mode) (org-mode . auto-fill-mode) @@ -868,19 +905,15 @@ And here's where my actual Org configurations begin: (setq org-latex-listings 'listings ;; org-latex-prefer-user-labels t ) - (add-to-list 'org-latex-packages-alist '("" "listings")) - (add-to-list 'org-latex-packages-alist '("" "color")) (add-to-list 'org-latex-classes '("IEEEtran" "\\documentclass[11pt]{IEEEtran}" - ("\\section{%s}" . "\\section*{%s}") - ("\\subsection{%s}" . "\\subsection*{%s}") + ("\\section{%s}" . "\\section*{%s}") + ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}") - ("\\paragraph{%s}" . "\\paragraph*{%s}") - ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) - t)) - -(use-feature ox-beamer - :after ox) + ("\\paragraph{%s}" . "\\paragraph*{%s}") + ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) + t) + (require 'ox-beamer)) #+end_src **** asynchronous tangle @@ -897,10 +930,14 @@ file. (defvar a/show-async-tangle-time nil "Show the time spent tangling the file.") - (defvar a/async-tangle-post-compile nil + (defvar a/async-tangle-post-compile + (when a/byte-compiled-init "make build-init") "If non-nil, pass to `compile' after successful tangle.") - (defvar a/async-tangle-byte-recompile t + ;; TODO: look into why directly byte-compiling init.el causes a + ;; number of problems, including magit-status not loading (busy + ;; waiting). + (defvar a/async-tangle-byte-recompile nil "If non-nil, byte-recompile the file on successful tangle.") (defun a/async-babel-tangle () @@ -919,7 +956,7 @@ file. `(lambda (result) (if result (progn - (setq byte-compile-warnings '(not noruntime unresolved)) + ;; (setq byte-compile-warnings '(not noruntime unresolved)) (message "Tangled %s%s" ,file-nodir (if a/show-async-tangle-time @@ -948,7 +985,7 @@ Not just how I do git, but /the/ way to do git. #+begin_src emacs-lisp (use-package magit - :defer 1 + :defer 2 :bind (("C-x g" . magit-status) ("s-g s" . magit-status) ("s-g l" . magit-log-buffer-file)) @@ -1051,7 +1088,7 @@ There's no way I could top that, so I won't attempt to. #+begin_src emacs-lisp (use-feature eshell - :defer 1 + :defer 2 :commands eshell :bind ("C-c a s e" . eshell) :config @@ -1280,9 +1317,17 @@ Highlight matching parens. #+begin_src emacs-lisp (use-feature paren + :demand :config (show-paren-mode)) #+end_src +** simple (for column numbers) + +#+begin_src emacs-lisp +(use-feature simple + :config (column-number-mode)) +#+end_src + ** =savehist= Save minibuffer history. @@ -1324,7 +1369,7 @@ Automatically save place in each file. #+begin_src emacs-lisp (use-package company - :defer 1 + :defer 3 :bind (:map company-active-map ([tab] . company-complete-common-or-cycle) @@ -1411,7 +1456,7 @@ Automatically save place in each file. ** [[https://coq.inria.fr][Coq]] (with [[https://github.com/ProofGeneral/PG][Proof General]]) #+begin_src emacs-lisp -(use-package proof-site +(use-package proof-site ; Proof General :straight proof-general) #+end_src @@ -1745,7 +1790,7 @@ treemacs :after (treemacs)) #+end_src -** COMMENT geiser +** geiser #+begin_src emacs-lisp (use-package geiser) @@ -1755,7 +1800,7 @@ treemacs (setq geiser-guile-load-path "~/src/git/guix")) #+end_src -** COMMENT guix +** guix #+begin_src emacs-lisp (use-package guix) @@ -1798,17 +1843,21 @@ Emacs package that displays available keybindings in popup ;; prefixes for my personal bindings "C-c a" "applications" "C-c a s" "shells" - "C-c b" "borg" + "C-c p" "package-management" + "C-c p e" "package-management/epkg" + "C-c p s" "straight.el" + "C-c psa" "all" + "C-c psp" "package" "C-c c" "compile-and-comments" "C-c e" "eval" "C-c f" "files" "C-c F" "frames" "C-S-h" "help(ful)" "C-c m" "multiple-cursors" - "C-c p" "projectile" - "C-c p s" "projectile/search" - "C-c p x" "projectile/execute" - "C-c p 4" "projectile/other-window" + "C-c P" "projectile" + "C-c P s" "projectile/search" + "C-c P x" "projectile/execute" + "C-c P 4" "projectile/other-window" "C-c q" "boxquote" "s-g" "magit" "s-o" "outline" @@ -1826,7 +1875,10 @@ Emacs package that displays available keybindings in popup "C-c C-e" "web/element" "C-c C-t" "web/tags") - (which-key-mode)) + (which-key-mode) + :custom + (which-key-add-column-padding 5) + (which-key-max-description-length 32)) #+end_src ** theme @@ -1841,6 +1893,7 @@ Emacs package that displays available keybindings in popup #+begin_src emacs-lisp (use-package smart-mode-line :commands (sml/apply-theme) + :demand :config (sml/setup)) #+end_src @@ -1854,19 +1907,29 @@ Emacs package that displays available keybindings in popup ** theme helper functions #+begin_src emacs-lisp +(defvar a/org-mode-font-lock-keywords + '(("[ \t]*\\(#\\+\\(BEGIN\\|END\\|begin\\|end\\)_\\(\\S-+\\)\\)[ \t]*\\([^\n:]*\\)" + (1 '(:foreground "#5a5b5a" :background "#292b2b") t) ; directive + (3 '(:foreground "#81a2be" :background "#292b2b") t) ; kind + (4 '(:foreground "#c5c8c6") t)))) ; title + (defun a/lights-on () "Enable my favourite light theme." (interactive) (mapc #'disable-theme custom-enabled-themes) (load-theme 'tangomod t) - (sml/apply-theme 'automatic)) + (sml/apply-theme 'automatic) + (font-lock-remove-keywords + 'org-mode a/org-mode-font-lock-keywords)) (defun a/lights-off () "Go dark." (interactive) (mapc #'disable-theme custom-enabled-themes) (load-theme 'doom-tomorrow-night t) - (sml/apply-theme 'automatic)) + (sml/apply-theme 'automatic) + (font-lock-add-keywords + 'org-mode a/org-mode-font-lock-keywords t)) (bind-keys ("s-t d" . a/lights-off) @@ -1902,7 +1965,7 @@ Emacs package that displays available keybindings in popup #+begin_src emacs-lisp (use-package projectile - :bind-keymap ("C-c p" . projectile-command-map) + :bind-keymap ("C-c P" . projectile-command-map) :config (projectile-mode) @@ -1923,7 +1986,7 @@ Emacs package that displays available keybindings in popup #+begin_src emacs-lisp (use-package helpful - :defer 1 + :defer 3 :bind (("C-S-h c" . helpful-command) ("C-S-h f" . helpful-callable) ; helpful-function @@ -1942,7 +2005,6 @@ Make =*scratch*= and =*Messages*= unkillable. :config (unkillable-scratch 1) :custom - (unkillable-scratch-behavior 'do-nothing) (unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$"))) #+end_src @@ -2015,11 +2077,9 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. #+begin_src emacs-lisp (use-package shrink-path + :defer 2 :after eshell :config - (setq eshell-prompt-regexp "\\(.*\n\\)*λ " - eshell-prompt-function #'+eshell/prompt) - (defun +eshell/prompt () (let ((base/dir (shrink-path-prompt default-directory))) (concat (propertize (car base/dir) @@ -2029,9 +2089,10 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. (propertize (+eshell--current-git-branch) 'face 'font-lock-function-name-face) "\n" - (propertize "λ" 'face 'eshell-prompt-face) + ;; "λ" + ;; (propertize "λ" 'face 'eshell-prompt) ;; needed for the input text to not have prompt face - (propertize " " 'face 'default)))) + (propertize "λ " 'face 'default)))) (defun +eshell--current-git-branch () (let ((branch (car (loop for match in (split-string (shell-command-to-string "git branch") "\n") @@ -2039,21 +2100,24 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. collect match)))) (if (not (eq branch nil)) (concat " " (substring branch 2)) - "")))) + ""))) + (setq eshell-prompt-regexp "\\(.*\n\\)*λ " + eshell-prompt-function #'+eshell/prompt)) #+end_src ** [[https://github.com/peterwvj/eshell-up][eshell-up]] #+begin_src emacs-lisp (use-package eshell-up - :after eshell) + :after eshell + :commands eshell-up) #+end_src ** multi-term #+begin_src emacs-lisp (use-package multi-term - :defer 1 + :defer 3 :bind (("C-c a s m" . multi-term-dedicated-toggle) :map term-mode-map ("C-c C-j" . term-char-mode) @@ -2113,6 +2177,14 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. ("a" . mc/mark-all-like-this)))) #+end_src +** forge + +#+begin_src emacs-lisp +(use-package forge + :after magit + :demand) +#+end_src + * Email :PROPERTIES: :CUSTOM_ID: email @@ -2163,7 +2235,11 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. gnus-save-newsrc-file nil gnus-read-newsrc-file nil gnus-interactive-exit nil - gnus-gcc-mark-as-read t)) + gnus-gcc-mark-as-read t) + :config + (require 'ebdb) + (require 'ebdb-mua) + (require 'ebdb-gnus)) (use-feature gnus-art :config @@ -2279,6 +2355,7 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. message-dont-reply-to-names "\\(\\(.*@aminb\\.org\\)\\|\\(amin@bandali\\.me\\)\\|\\(\\(aminb?\\|mab\\|bandali\\)@gnu\\.org\\)\\|\\(\\(m\\|a\\(min\\.\\)?\\)bandali@uwaterloo\\.ca\\)\\)" message-user-fqdn "aminb.org") + (require 'company-ebdb) :hook (;; (message-setup . mml-secure-message-sign-pgpmime) (message-mode . flyspell-mode) (message-mode . (lambda () @@ -2325,6 +2402,7 @@ Convenient footnotes in =message-mode=. #+begin_src emacs-lisp (use-package ebdb + :straight (:host github :repo "girzel/ebdb") :after gnus :bind (:map gnus-group-mode-map ("e" . ebdb)) :config @@ -2341,13 +2419,8 @@ Convenient footnotes in =message-mode=. ;; (ebdb-complete-enable)) (use-package company-ebdb - :after (:all company message) :config - (defun company-ebdb--post-complete (_) nil) - :hook - (message-mode . (lambda () - (add-to-list (make-local-variable 'company-backends) - 'company-ebdb)))) + (defun company-ebdb--post-complete (_) nil)) (use-feature ebdb-gnus :after ebdb @@ -2373,9 +2446,13 @@ Convenient footnotes in =message-mode=. ;; :after ebdb) #+end_src -** COMMENT message-x +** message-x #+begin_src emacs-lisp +(use-package message-x) +#+end_src + +#+begin_src emacs-lisp :tangle no (use-package message-x :custom (message-x-completion-alist @@ -2409,10 +2486,11 @@ Convenient footnotes in =message-mode=. #+begin_src emacs-lisp (use-package ox-hugo - :after ox) + :after ox + :demand) (use-feature ox-hugo-auto-export - :after ox-hugo) + :demand) #+end_src * Post initialization @@ -2440,5 +2518,5 @@ Display how long it took to load the init file. * COMMENT Local Variables :ARCHIVE: # Local Variables: # eval: (add-hook 'after-save-hook #'a/async-babel-tangle 'append 'local) -# eval: (typo-mode -1) +# eval: (when (featurep 'typo (typo-mode -1))) # End: