refactor(literate): DRY tangling

And remove unused cache file.

Ref: #6281
This commit is contained in:
Henrik Lissner 2022-06-24 21:11:43 +02:00
parent c2f8476c86
commit 74cc541597
No known key found for this signature in database
GPG key ID: B60957CA074D39A3

View file

@ -1,103 +1,24 @@
;;; config/literate/autoload.el -*- lexical-binding: t; -*- ;;; config/literate/autoload.el -*- lexical-binding: t; -*-
;;;###autoload (add-hook 'org-mode-hook #'+literate-enable-recompile-h)
(defvar +literate-config-file (defvar +literate-config-file
(concat doom-private-dir "config.org") (concat doom-private-dir "config.org")
"The file path of your literate config file.") "The file path of your literate config file.")
(defvar +literate-config-cache-file
(concat doom-cache-dir "literate-last-compile")
"The file path that `+literate-config-file' will be tangled to, then
byte-compiled from.")
(defvar +literate-tangle--async-proc nil) (defvar +literate-tangle--async-proc nil)
(defvar +literate-tangle--async-proc-start-time nil) (defvar +literate-tangle--async-proc-start-time nil)
(defvar org-mode-hook) (defvar org-mode-hook)
(defvar org-inhibit-startup) (defvar org-inhibit-startup)
;;;###autoload (add-hook 'org-mode-hook #'+literate-enable-recompile-h) (defun +literate-tangle (target dest &optional dir)
"Tangle TARGET org file to DEST."
;;;###autoload (and (require 'ox nil t)
(defun +literate-tangle-h ()
"Tangles `+literate-config-file' if it has changed.
This is performed with an asyncronous Emacs process, except when
`doom-interactive-p' is non-nil."
(if doom-interactive-p
(+literate-tangle--async)
(+literate-tangle--sync)))
(defun +literate-tangle--async ()
"Tangles `+literate-config-file' using an async Emacs process."
(unless (getenv "__NOTANGLE")
(let ((default-directory doom-private-dir)
(target +literate-config-file)
(cache +literate-config-cache-file)
(dest (expand-file-name (concat doom-module-config-file ".el"))))
(when +literate-tangle--async-proc
(message "Killing outdated tangle process...")
(set-process-sentinel +literate-tangle--async-proc #'ignore)
(kill-process +literate-tangle--async-proc)
(sit-for 0.3)) ; ensure the message is seen for a bit
(setq +literate-tangle--async-proc-start-time (float-time)
+literate-tangle--async-proc
;; See `+literate-tangle--sync' for an explanation of the (progn ...) below.
(start-process "tangle-config"
(get-buffer-create " *tangle config*")
"emacs" "--batch" "--eval"
(format "(progn \
(require 'ox) \
(require 'ob-tangle) \
(setq org-startup-indented nil \
org-startup-folded nil \
vc-handled-backends nil \
write-file-functions nil \
before-save-hook nil \
after-save-hook nil \
org-mode-hook nil \
org-inhibit-startup t \
org-confirm-babel-evaluate nil) \
(org-babel-tangle-file %S %S) \
(with-temp-file %S) \
)" target dest cache)))
(set-process-sentinel +literate-tangle--async-proc #'+literate-tangle--async-sentinel)
(run-at-time nil nil (lambda () (message "Tangling config.org"))) ; ensure shown after a save message
"Tangling config.org...")))
(defun +literate-tangle--async-sentinel (process signal)
(cond
((and (eq 'exit (process-status process))
(= 0 (process-exit-status process)))
(message "Tangled config.org sucessfully (took %.1fs)"
(- (float-time) +literate-tangle--async-proc-start-time))
(setq +literate-tangle--async-proc nil))
((memq (process-status process) (list 'exit 'signal))
(pop-to-buffer (get-buffer " *tangle config*"))
(message "Failed to tangle config.org (after %.1fs)"
(- (float-time) +literate-tangle--async-proc-start-time))
(setq +literate-tangle--async-proc nil))))
(defun +literate-tangle-check-finished ()
"When a tangle is still in progress, ask the user if they want to wait for it."
(when (and (process-live-p +literate-tangle--async-proc)
(yes-or-no-p "Config is currently retangling, would you please wait a few seconds?"))
(switch-to-buffer " *tangle config*")
(signal 'quit nil)))
(add-hook! 'kill-emacs-hook #'+literate-tangle-check-finished)
(defun +literate-tangle--sync ()
"Tangles `+literate-config-file' if it has changed."
(and (not (getenv "__NOTANGLE"))
(require 'ox nil t)
(require 'ob-tangle nil t) (require 'ob-tangle nil t)
(letf! ((default-directory doom-private-dir) (let* ((default-directory (or dir default-directory))
(target +literate-config-file) (target (expand-file-name target))
(cache +literate-config-cache-file) (dest (expand-file-name dest)))
(dest (expand-file-name (concat doom-module-config-file ".el")))
;; Ensure output conforms to the formatting of all doom CLIs
(defun message (msg &rest args)
(when msg
(print! (item "%s") (apply #'format msg args)))))
(print! (start "Compiling your literate config...")) (print! (start "Compiling your literate config..."))
(print-group! (print-group!
(let (;; Do as little unnecessary work as possible in these org files. (let (;; Do as little unnecessary work as possible in these org files.
@ -120,15 +41,89 @@ This is performed with an asyncronous Emacs process, except when
;; trust that you know what you're doing! ;; trust that you know what you're doing!
(org-confirm-babel-evaluate nil)) (org-confirm-babel-evaluate nil))
(org-babel-tangle-file target dest)) (org-babel-tangle-file target dest))
;; Write an empty file to serve as our mtime cache t))))
(with-temp-file cache)
(if doom-interactive-p t (defun +literate-tangle--sync ()
(print! "Restarting...") "Tangles `+literate-config-file' if it has changed."
(exit! "__DOOMRESTART=1 __NOTANGLE=1 $@")))))) (and (not (getenv "__NOTANGLE"))
(+literate-tangle +literate-config-file
(concat doom-module-config-file ".el")
doom-private-dir)
(always (print! "Restarting..."))
(exit! "__DOOMRESTART=1 __NOTANGLE=1 $@")))
(defun +literate-tangle--async ()
"Tangles `+literate-config-file' using an async Emacs process."
(unless (getenv "__NOTANGLE")
(when +literate-tangle--async-proc
(message "Killing outdated tangle process...")
(set-process-sentinel +literate-tangle--async-proc #'ignore)
(kill-process +literate-tangle--async-proc)
(sit-for 0.3)) ; ensure the message is seen for a bit
(setq +literate-tangle--async-proc-start-time (float-time)
+literate-tangle--async-proc
;; See `+literate-tangle--sync' for an explanation of the (progn ...) below.
(start-process "tangle-config"
(get-buffer-create " *tangle config*")
"emacs" "--batch"
"--eval"
(prin1-to-string
`(progn
(defvar doom-interactive-p nil)
(defvar doom-debug-p ,doom-debug-p)
(require 'cl-lib)
(require 'subr-x)
(load ,(doom-path doom-core-dir "autoload/print"))
(funcall #',(symbol-function #'+literate-tangle)
,+literate-config-file
,(concat doom-module-config-file ".el")
,doom-private-dir)))))
(add-hook 'kill-emacs-hook #'+literate-tangle-check-finished-h)
(set-process-sentinel +literate-tangle--async-proc #'+literate-tangle--async-sentinel)
(run-at-time nil nil (lambda () (message "Tangling config.org"))) ; ensure shown after a save message
"Tangling config.org..."))
(defun +literate-tangle--async-sentinel (process signal)
(cond
((and (eq 'exit (process-status process))
(= 0 (process-exit-status process)))
(message "Tangled config.org sucessfully (took %.1fs)"
(- (float-time) +literate-tangle--async-proc-start-time))
(setq +literate-tangle--async-proc nil))
((memq (process-status process) '(exit signal))
(pop-to-buffer (get-buffer " *tangle config*"))
(message "Failed to tangle config.org (after %.1fs)"
(- (float-time) +literate-tangle--async-proc-start-time))
(setq +literate-tangle--async-proc nil))))
;;
;;; Commands
;;;###autoload ;;;###autoload
(defalias '+literate/reload #'doom/reload) (defalias '+literate/reload #'doom/reload)
;;
;;; Hooks
;;;###autoload
(defun +literate-tangle-h ()
"Tangles `+literate-config-file' if it has changed.
This is performed with an asyncronous Emacs process, except when
`doom-interactive-p' is non-nil."
(if doom-interactive-p
(+literate-tangle--async)
(+literate-tangle--sync)))
;;;###autoload
(defun +literate-tangle-check-finished-h ()
"When a tangle is still in progress, ask the user if they want to wait for it."
(when (and (process-live-p +literate-tangle--async-proc)
(yes-or-no-p "Config is currently retangling, would you please wait a few seconds?"))
(switch-to-buffer " *tangle config*")
(signal 'quit nil)))
;;;###autoload ;;;###autoload
(defun +literate-enable-recompile-h () (defun +literate-enable-recompile-h ()
"Enable literate-compiling-on-save in the current buffer." "Enable literate-compiling-on-save in the current buffer."
@ -141,5 +136,6 @@ This is performed with an asyncronous Emacs process, except when
We assume any org file in `doom-private-dir' is connected to your literate We assume any org file in `doom-private-dir' is connected to your literate
config, and should trigger a recompile if changed." config, and should trigger a recompile if changed."
(and (file-in-directory-p (and (file-in-directory-p
buffer-file-name (file-name-directory +literate-config-file)) (buffer-file-name (buffer-base-buffer))
(file-name-directory +literate-config-file))
(+literate-tangle-h))) (+literate-tangle-h)))