X-Git-Url: https://git.shemshak.org/gitweb.cgi/~bandali/configs/blobdiff_plain/1323384f45451b35419647b87bbf9f18434e6fef..f0d07afcb32a0b1e9314448779987d8664f6e4dc:/init.org?ds=inline diff --git a/init.org b/init.org index e58ca6c..6193a21 100644 --- a/init.org +++ b/init.org @@ -32,6 +32,46 @@ 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 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://git.sr.ht/~bandali/dotfiles ~/.emacs.d +cd ~/.emacs.d +#+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]] @@ -201,7 +241,8 @@ hacker. #+begin_src emacs-lisp ;; Main engine start... -(setq straight-repository-branch "develop") +(setq straight-repository-branch "develop" + straight-check-for-modifications '(check-on-save find-when-checking)) (defun a/bootstrap-straight () (defvar bootstrap-version) @@ -255,11 +296,13 @@ 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)) @@ -346,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 @@ -798,7 +842,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 @@ -810,13 +854,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) @@ -834,20 +871,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 - :demand - :after ox) + ("\\paragraph{%s}" . "\\paragraph*{%s}") + ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) + t) + (require 'ox-beamer)) #+end_src **** asynchronous tangle @@ -864,9 +896,13 @@ file. (defvar a/show-async-tangle-time nil "Show the time spent tangling the file.") - (defvar a/async-tangle-post-compile "make bi" + (defvar a/async-tangle-post-compile + (when a/byte-compiled-init "make build-init") "If non-nil, pass to `compile' after successful tangle.") + ;; 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.") @@ -886,7 +922,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 @@ -915,7 +951,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)) @@ -1018,7 +1054,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 @@ -1247,6 +1283,7 @@ Highlight matching parens. #+begin_src emacs-lisp (use-feature paren + :demand :config (show-paren-mode)) #+end_src @@ -1298,7 +1335,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) @@ -1385,7 +1422,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 @@ -1831,19 +1868,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) @@ -1900,7 +1947,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 @@ -1992,10 +2039,8 @@ 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) @@ -2015,22 +2060,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 - :commands 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) @@ -2140,7 +2187,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 @@ -2256,6 +2307,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 () @@ -2319,17 +2371,11 @@ 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 - :demand :custom (ebdb-gnus-window-configuration '(article @@ -2341,7 +2387,6 @@ Convenient footnotes in =message-mode=. (use-feature ebdb-mua :after ebdb - :demand ;; :custom (ebdb-mua-pop-up nil) )