From c5d8bb25b186af5250b92186de2a0fbd3e652a75 Mon Sep 17 00:00:00 2001 From: Amin Bandali Date: Sun, 23 Dec 2018 15:05:14 -0500 Subject: [PATCH] [emacs] drop the various doom-like naming conventions, simply use a/ --- etc/custom.el | 2 +- init.org | 122 ++++++++++++++++++++++---------------------------- 2 files changed, 54 insertions(+), 70 deletions(-) diff --git a/etc/custom.el b/etc/custom.el index be0ffab..b28cc4d 100644 --- a/etc/custom.el +++ b/etc/custom.el @@ -60,7 +60,7 @@ [//]: # \"Exported with love from a post written in Org mode\" [//]: # \"- https://ox-hugo.scripter.co\"") - (eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local))) + (eval add-hook 'after-save-hook #'a/async-babel-tangle 'append 'local))) '(unkillable-buffers '("^\\*scratch\\*$" "^\\*Messages\\*$"))) (custom-set-faces ;; custom-set-faces was added by Custom. diff --git a/init.org b/init.org index 61af647..acab132 100644 --- a/init.org +++ b/init.org @@ -104,28 +104,12 @@ file. #+begin_src emacs-lisp :comments none ;;; Commentary: -;; Emacs configuration of Amin Bandali, computer scientist and functional -;; programmer. +;; Emacs configuration of Amin Bandali, computer scientist, functional +;; programmer, and free software advocate. ;; THIS FILE IS AUTO-GENERATED FROM `init.org'. #+end_src -** Naming conventions - -The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s, found [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. - -#+begin_src emacs-lisp :comments none -;; Naming conventions: -;; -;; amin-... public variables or non-interactive functions -;; amin--... private anything (non-interactive), not safe for direct use -;; amin/... an interactive function; safe for M-x or keybinding -;; amin|... a hook function -;; amin*... an advising function -;; amin@... a hydra command -;; ...! a macro -#+end_src - * Initial setup :PROPERTIES: :CUSTOM_ID: initial-setup @@ -138,10 +122,10 @@ let's see how long Emacs takes to start up, before even loading =init.el=, i.e. =user-init-file=: #+begin_src emacs-lisp -(defvar amin--before-user-init-time (current-time) +(defvar a/before-user-init-time (current-time) "Value of `current-time' when Emacs begins loading `user-init-file'.") (message "Loading Emacs...done (%.3fs)" - (float-time (time-subtract amin--before-user-init-time + (float-time (time-subtract a/before-user-init-time before-init-time))) #+end_src @@ -151,9 +135,9 @@ frequency. Clearing the ~file-name-handler-alist~ seems to help reduce startup time as well. #+begin_src emacs-lisp -(defvar amin--gc-cons-threshold gc-cons-threshold) -(defvar amin--gc-cons-percentage gc-cons-percentage) -(defvar amin--file-name-handler-alist file-name-handler-alist) +(defvar a/gc-cons-threshold gc-cons-threshold) +(defvar a/gc-cons-percentage gc-cons-percentage) +(defvar a/file-name-handler-alist file-name-handler-alist) (setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB gc-cons-percentage 0.6 file-name-handler-alist nil @@ -168,9 +152,9 @@ done initializing. (add-hook 'after-init-hook (lambda () - (setq gc-cons-threshold amin--gc-cons-threshold - gc-cons-percentage amin--gc-cons-percentage - file-name-handler-alist amin--file-name-handler-alist))) + (setq gc-cons-threshold a/gc-cons-threshold + gc-cons-percentage a/gc-cons-percentage + file-name-handler-alist a/file-name-handler-alist))) #+end_src Increase the number of lines kept in message logs (the =*Messages*= @@ -433,7 +417,7 @@ Let’s define a function to conveniently disable this for certain buffers and/or modes. #+begin_src emacs-lisp -(defun amin--no-mouse-autoselect-window () +(defun a/no-mouse-autoselect-window () (make-local-variable 'mouse-autoselect-window) (setq mouse-autoselect-window nil)) #+end_src @@ -450,7 +434,7 @@ buffers and/or modes. Convenience macro for =setq='ing multiple variables to the same value: #+begin_src emacs-lisp -(defmacro setq-every! (value &rest vars) +(defmacro a/setq-every (value &rest vars) "Set all the variables from VARS to value VALUE." (declare (indent defun) (debug t)) `(progn ,@(mapcar (lambda (x) (list 'setq x value)) vars))) @@ -627,12 +611,12 @@ Based on https://stackoverflow.com/a/17788551, with changes to use #+begin_src emacs-lisp (with-eval-after-load 'compile - (defun amin--compilation-finish-function (buffer outstr) + (defun a/compilation-finish-function (buffer outstr) (unless (string-match "finished" outstr) (switch-to-buffer-other-window buffer)) t) - (setq compilation-finish-functions #'amin--compilation-finish-function) + (setq compilation-finish-functions #'a/compilation-finish-function) (require 'cl-macs) @@ -784,22 +768,22 @@ In short, my favourite way of life. **** asynchronous tangle -=amin/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's +=a/async-babel-tangle= is a function closely inspired by [[https://github.com/dieggsy/dotfiles/tree/cc10edf7701958eff1cd94d4081da544d882a28c/emacs.d#dotfiles][dieggsy's d/async-babel-tangle]] which uses [[https://github.com/jwiegley/emacs-async][async]] to asynchronously tangle an org file. #+begin_src emacs-lisp (with-eval-after-load 'org - (defvar amin-show-async-tangle-results nil + (defvar a/show-async-tangle-results nil "Keep *emacs* async buffers around for later inspection.") - (defvar amin-show-async-tangle-time nil + (defvar a/show-async-tangle-time nil "Show the time spent tangling the file.") - (defvar amin-async-tangle-post-compile "make ti" + (defvar a/async-tangle-post-compile "make ti" "If non-nil, pass to `compile' after successful tangle.") - (defun amin/async-babel-tangle () + (defun a/async-babel-tangle () "Tangle org file asynchronously." (interactive) (let* ((file-tangle-start-time (current-time)) @@ -811,24 +795,24 @@ file. `(lambda () (require 'org) (org-babel-tangle-file ,file)) - (unless amin-show-async-tangle-results + (unless a/show-async-tangle-results `(lambda (result) (if result (progn (message "Tangled %s%s" ,file-nodir - (if amin-show-async-tangle-time + (if a/show-async-tangle-time (format " (%.3fs)" (float-time (time-subtract (current-time) ',file-tangle-start-time))) "")) - (when amin-async-tangle-post-compile - (compile amin-async-tangle-post-compile))) + (when a/async-tangle-post-compile + (compile a/async-tangle-post-compile))) (message "Tangling %s failed" ,file-nodir)))))))) (add-to-list 'safe-local-variable-values - '(eval add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local)) + '(eval add-hook 'after-save-hook #'a/async-babel-tangle 'append 'local)) #+end_src *** [[https://magit.vc/][Magit]] @@ -924,28 +908,28 @@ There's no way I could top that, so I won't attempt to. :bind ("C-c a s e" . eshell) :config (eval-when-compile (defvar eshell-prompt-regexp)) - (defun amin/eshell-quit-or-delete-char (arg) + (defun a/eshell-quit-or-delete-char (arg) (interactive "p") (if (and (eolp) (looking-back eshell-prompt-regexp nil)) (eshell-life-is-too-much) (delete-char arg))) - (defun amin/eshell-clear () + (defun a/eshell-clear () (interactive) (let ((inhibit-read-only t)) (erase-buffer)) (eshell-send-input)) - (defun amin|eshell-setup () + (defun a/eshell-setup () (make-local-variable 'company-idle-delay) (defvar company-idle-delay nil) (bind-keys :map eshell-mode-map - ("C-d" . amin/eshell-quit-or-delete-char) - ("C-S-l" . amin/eshell-clear) + ("C-d" . a/eshell-quit-or-delete-char) + ("C-S-l" . a/eshell-clear) ("M-r" . counsel-esh-history) ([tab] . company-complete))) - :hook (eshell-mode . amin|eshell-setup) + :hook (eshell-mode . a/eshell-setup) :custom (eshell-hist-ignoredups t) (eshell-input-filter 'eshell-input-filter-initial-space)) @@ -1034,7 +1018,7 @@ There's no way I could top that, so I won't attempt to. ("" . outline-toggle-children) ("M-p" . outline-previous-visible-heading) ("M-n" . outline-next-visible-heading) - :prefix-map amin--outline-prefix-map + :prefix-map a/outline-prefix-map :prefix "s-o" ("TAB" . outline-toggle-children) ("a" . outline-hide-body) @@ -1455,7 +1439,7 @@ instead. :defer t :mode "\\.html\\'" :config - (setq-every! 2 + (a/setq-every 2 web-mode-code-indent-offset web-mode-css-indent-offset web-mode-markup-indent-offset)) @@ -1613,14 +1597,14 @@ Emacs package that displays available keybindings in popup ** theme helper functions #+begin_src emacs-lisp -(defun amin/lights-on () +(defun a/lights-on () "Enable my favourite light theme." (interactive) (mapc #'disable-theme custom-enabled-themes) (load-theme 'tangomod t) (sml/apply-theme 'automatic)) -(defun amin/lights-off () +(defun a/lights-off () "Go dark." (interactive) (mapc #'disable-theme custom-enabled-themes) @@ -1628,8 +1612,8 @@ Emacs package that displays available keybindings in popup (sml/apply-theme 'automatic)) (bind-keys - ("s-t d" . amin/lights-off) - ("s-t l" . amin/lights-on)) + ("s-t d" . a/lights-off) + ("s-t l" . a/lights-on)) #+end_src ** [[https://github.com/bbatsov/crux][crux]] @@ -1718,7 +1702,7 @@ Make =*scratch*= and =*Messages*= unkillable. (use-package boxquote :defer 3 :bind - (:prefix-map amin--boxquote-prefix-map + (:prefix-map a/boxquote-prefix-map :prefix "C-c q" ("b" . boxquote-buffer) ("B" . boxquote-insert-buffer) @@ -1858,18 +1842,18 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. :END: #+begin_src emacs-lisp -(defvar amin-maildir (expand-file-name "~/mail/")) +(defvar a/maildir (expand-file-name "~/mail/")) (with-eval-after-load 'recentf - (add-to-list 'recentf-exclude amin-maildir)) + (add-to-list 'recentf-exclude a/maildir)) #+end_src ** Gnus #+begin_src emacs-lisp (setq - amin-gnus-init-file (no-littering-expand-etc-file-name "gnus") - mail-user-agent 'gnus-user-agent - read-mail-command 'gnus) + a/gnus-init-file (no-littering-expand-etc-file-name "gnus") + mail-user-agent 'gnus-user-agent + read-mail-command 'gnus) (use-package gnus :bind (("C-c m" . gnus) @@ -1937,7 +1921,7 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. (use-package gnus-sum :bind (:map gnus-summary-mode-map - :prefix-map amin--gnus-summary-prefix-map + :prefix-map a/gnus-summary-prefix-map :prefix "v" ("r" . gnus-summary-reply) ("w" . gnus-summary-wide-reply) @@ -1948,7 +1932,7 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. ("r" . gnus-summary-reply-with-original) ("R" . gnus-summary-wide-reply-with-original) ("M-L" . org-store-link)) - :hook (gnus-summary-mode . amin--no-mouse-autoselect-window)) + :hook (gnus-summary-mode . a/no-mouse-autoselect-window)) (use-package gnus-msg :config @@ -1956,13 +1940,13 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. '((".*" (address "amin@aminb.org") (body "\nBest,\namin\n") - (eval (setq amin--message-cite-say-hi t))) + (eval (setq a/message-cite-say-hi t))) ("gnu.*" (address "bandali@gnu.org")) ((header "subject" "ThankCRM") (to "webmasters-comment@gnu.org") (body "\nAdded to 2018supporters.html.\n\nMoving to campaigns.\n\n-amin\n") - (eval (setq amin--message-cite-say-hi nil))) + (eval (setq a/message-cite-say-hi nil))) ("nnimap\\+uwaterloo:.*" (address "abandali@uwaterloo.ca") (gcc "\"nnimap+uwaterloo:Sent Items\""))))) @@ -2000,7 +1984,7 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. #+begin_src emacs-lisp (use-package message :config - (defconst amin--message-cite-style-format "On %Y-%m-%d %l:%M %p, %N wrote:") + (defconst a/message-cite-style-format "On %Y-%m-%d %l:%M %p, %N wrote:") (defconst message-cite-style-bandali '((message-cite-function 'message-cite-original) (message-citation-line-function 'message-insert-formatted-citation-line) @@ -2009,9 +1993,9 @@ Also see [[https://www.emacswiki.org/emacs/rebox2][rebox2]]. (message-yank-cited-prefix ">") (message-yank-empty-prefix ">") (message-citation-line-format - (if amin--message-cite-say-hi - (concat "Hi %F,\n\n" amin--message-cite-style-format) - amin--message-cite-style-format))) + (if a/message-cite-say-hi + (concat "Hi %F,\n\n" a/message-cite-style-format) + a/message-cite-style-format))) "Citation style based on Mozilla Thunderbird's. Use with message-cite-style.") (setq message-cite-style 'message-cite-style-bandali message-kill-buffer-on-exit t @@ -2047,7 +2031,7 @@ Convenient footnotes in =message-mode=. :after message :bind (:map message-mode-map - :prefix-map amin--footnote-prefix-map + :prefix-map a/footnote-prefix-map :prefix "C-c f" ("a" . footnote-add-footnote) ("b" . footnote-back-to-message) @@ -2166,7 +2150,7 @@ Display how long it took to load the init file. #+begin_src emacs-lisp (message "Loading %s...done (%.3fs)" user-init-file (float-time (time-subtract (current-time) - amin--before-user-init-time))) + a/before-user-init-time))) #+end_src * Footer @@ -2180,6 +2164,6 @@ Display how long it took to load the init file. * COMMENT Local Variables :ARCHIVE: # Local Variables: -# eval: (add-hook 'after-save-hook #'amin/async-babel-tangle 'append 'local) +# eval: (add-hook 'after-save-hook #'a/async-babel-tangle 'append 'local) # eval: (typo-mode -1) # End: -- 2.20.1