emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

config/literate: improve tangling algorithm

Browse source 
- Tangling no longer adds temp files to recentf (#3685)
- If :tangle yes is used, the result is no longer tangled to
  /tmp/config.org.*.el
- In interactive sessions the org buffer is no longer interfered with
  when tangling (by scrolling up to the top of the page, or undoing
  overlays/markers).
- Tangling no longer triggers formatters (or any save/write hooks).
- Appease byte-compiler sama, complaining about free variables.
This commit is contained in:
Henrik Lissner 2020-08-08 02:57:04 -04:00
parent aae8203f86
commit d2bc2ff44b
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
2 changed files with 52 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

3
core/core-cli.el
View file

@ -18,6 +18,9 @@
(require 'core-packages)
(doom-initialize-core-packages)
;; Don't generate superfluous files when writing temp buffers
(setq make-backup-files nil)
;;
;;; Variables

75
modules/config/literate/autoload.el
View file

@ -9,41 +9,64 @@
"The file path that `+literate-config-file' will be tangled to, then
byte-compiled from.")
(defvar org-mode-hook)
(defvar org-inhibit-startup)
;;;###autoload
(defun +literate-tangle-h ()
"Tangles `+literate-config-file' if it has changed."
(print! (start "Compiling your literate config..."))
(print-group!
(let* ((default-directory doom-private-dir)
(org (expand-file-name +literate-config-file))
(dest (concat (file-name-sans-extension +literate-config-file) ".el"))
;; Operate on a copy because `org-babel-tangle' has side-effects we
;; don't want to impose on the User's config permanently.
(backup (make-temp-file (concat (file-name-nondirectory org) "."))))
(unwind-protect
(and (require 'ox)
(require 'ob-tangle)
(letf! ((defun message (msg &rest args)
(when msg
(print! (info "%s") (apply #'format msg args))))
;; Prevent infinite recursion due to recompile-on-save
;; hooks later.
(org-mode-hook nil))
;; Tangling won't ordinarily expand #+INCLUDE directives, and it
;; modifies the buffer so we must do it in a copy to prevent
;; stepping on the user's toes.
(org (expand-file-name +literate-config-file))
(dest (concat (file-name-sans-extension +literate-config-file) ".el")))
(and (require 'ox)
(require 'ob-tangle)
(letf! (;; Operate on a copy because `org-babel-tangle' has
;; side-effects we need to undo immediately as not to
;; overwrite the user's config; it's bad ettiquite.
(backup (make-temp-file (concat (file-name-nondirectory org) ".")))
;; A hack to prevent ob-tangle from operating relative to the
;; backup file and thus tangling to the wrong destinations.
(defun org-babel-tangle-single-block (&rest args)
(let* ((spec (apply org-babel-tangle-single-block args))
(file (nth 1 spec))
(file (if (file-equal-p file backup) org file))
(file (if org-babel-tangle-use-relative-file-links
(file-relative-name file)
file)))
(setf (nth 1 spec) file)
spec))
;; Ensure output conforms to the formatting of all doom CLIs
(defun message (msg &rest args)
(when msg
(print! (info "%s") (apply #'format msg args)))))
(unwind-protect
(with-temp-file backup
(insert-file-contents org)
(let ((buffer-file-name backup)
(org-inhibit-startup t)
org-mode-hook)
(insert-file-contents org)
;; Prevent unwanted entries in recentf, or formatters, or
;; anything that could be on these hooks, really. Nothing
;; else should be touching these files (particularly in
;; interactive sessions).
(write-file-functions nil)
(before-save-hook nil)
(after-save-hook nil)
;; Prevent infinite recursion due to recompile-on-save
;; hooks later, and speed up `org-mode' init.
(org-mode-hook nil)
(org-inhibit-startup t))
(org-mode)
(org-export-expand-include-keyword)
(org-babel-tangle nil dest)))
t)
;; Write an empty file to serve as our mtime cache
(with-temp-file +literate-config-cache-file))
(ignore-errors (delete-file backup))))))
(with-silent-modifications
;; Tangling won't ordinarily expand #+INCLUDE directives,
;; so I do it myself.
(org-export-expand-include-keyword)
(org-babel-tangle nil dest))))
(ignore-errors (delete-file backup)))
;; Write an empty file to serve as our mtime cache
(with-temp-file +literate-config-cache-file)
t)))))
;;;###autoload
(add-hook 'org-mode-hook #'+literate-enable-recompile-h)