aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-03 18:25:58 -0500
committerCraig Jennings <c@cjennings.net>2026-05-03 18:25:58 -0500
commit475d6305e150c0a8ac61738eabe434c432acd991 (patch)
tree77093ef1afd7cb0ae259e1655b8641cbf7c9e40e /modules
parentdbce94b38f3267e59b015880d34ff31104126e47 (diff)
downloaddotemacs-475d6305e150c0a8ac61738eabe434c432acd991.tar.gz
dotemacs-475d6305e150c0a8ac61738eabe434c432acd991.zip
feat(dev-fkeys): revert projectile cache on failed-and-modified compile
Without this, a one-off typo at projectile's compile/test/run prompt poisons the per-project cache: every subsequent invocation pre-fills the broken value. I hit it during the Phase 2a live-test, where projectile's "All tests" prompt was replaying `go test ../.` and there was no clean way to get the prior known-good back. Three pieces of machinery, all in `dev-fkeys.el`: `cj/--projectile-capture-cmd' captures the current cached cmd at the project root before each invocation, stashing a plist with :map / :root / :prior in `cj/--projectile-revert-state'. `cj/--projectile-revert-on-fail' is a `compilation-finish-functions' hook that reads that state. If the compile failed AND the cmd was modified from the captured prior value AND the prior was non-nil, it puts the prior back in projectile's cmd-map. Test-fails-because-of-real-bug (cmd unchanged through the run) leaves the cache alone. The hook self-removes on first invocation regardless of outcome and clears the state. `cj/--projectile-around-revert' is the around-advice that wires the two together. I added the advice to all three projectile cmd-runners — `projectile-compile-project', `projectile-test-project', `projectile-run-project' — so the auto-revert applies whether the user invoked via F4 / F6 or directly via `M-x'. Plus the manual escape-hatch: `cj/projectile-reset-cmds' clears compile/test/run cache for the current project. Bound to `C-; P' under the personal keymap. Use when projectile's auto-derived default was wrong from the start and you want to start fresh — the next F4 / F6 invocation re-derives projectile's project-type default. TDD: 18 new tests across 4 files, one per helper. The around-advice tests build the capture/install/orig-fn flow against stub cmd-maps and verify state captured, hook installed, orig-fn invoked. The revert hook tests cover failure-and-modified (revert), success (leave alone), failure-but-unchanged (leave alone), nil prior (leave alone), nil state (no-op), and self-removal. The reset-cmds tests cover the all-three-maps clear, no-cached-entry no-op, and no-project user-error.
Diffstat (limited to 'modules')
-rw-r--r--modules/dev-fkeys.el93
1 files changed, 93 insertions, 0 deletions
diff --git a/modules/dev-fkeys.el b/modules/dev-fkeys.el
index a6f41adf..8c5b388c 100644
--- a/modules/dev-fkeys.el
+++ b/modules/dev-fkeys.el
@@ -167,6 +167,80 @@ a single Compile entry that calls plain `compile'."
('interpreted '(("Run" . run-only)))
(_ '(("Compile" . compile-plain)))))
+;; ---------- Projectile cache revert on failure ----------
+;;
+;; Without this, a one-off typo at projectile's prompt poisons the per-
+;; project cmd cache: every subsequent invocation pre-fills the broken
+;; value. The capture/finish-hook pair installed by `:around' advice on
+;; the three projectile cmd-runners reverts the cache to its prior value
+;; if the compile fails AND the cmd was modified. A test that fails
+;; because of a real code bug (cmd unchanged) leaves the cache alone.
+
+(defvar cj/--projectile-revert-state nil
+ "Plist describing the projectile cache state to potentially revert.
+Set by `cj/--projectile-capture-cmd' before each invocation; read and
+cleared by `cj/--projectile-revert-on-fail' after the compile finishes.
+Keys: :map (cmd-map symbol), :root (project root), :prior (cached cmd
+before invocation, may be nil).")
+
+(defun cj/--projectile-capture-cmd (map-symbol)
+ "Capture the cached cmd at the project root in MAP-SYMBOL.
+MAP-SYMBOL is the symbol of a projectile cmd-map (e.g.
+`projectile-compile-cmd-map'). Stashes a plist in
+`cj/--projectile-revert-state' for the finish hook to read. No-op when
+the project root cannot be resolved or MAP-SYMBOL is unbound (projectile
+not loaded)."
+ (let ((root (cj/--f4-project-root)))
+ (when (and root (boundp map-symbol))
+ (let ((prior (gethash root (symbol-value map-symbol))))
+ (setq cj/--projectile-revert-state
+ (list :map map-symbol :root root :prior prior))))))
+
+(defun cj/--projectile-revert-on-fail (_buf status)
+ "Compilation-finish hook: revert projectile cache on failed-and-modified.
+Always self-removes from `compilation-finish-functions' and clears
+`cj/--projectile-revert-state'. Reverts the cmd-map entry only when the
+compile failed AND the cmd was modified from the captured prior value
+AND that prior was non-nil. The unchanged-and-failed case (test fails
+because of a real bug) leaves the cache alone."
+ (remove-hook 'compilation-finish-functions #'cj/--projectile-revert-on-fail)
+ (let ((state cj/--projectile-revert-state))
+ (setq cj/--projectile-revert-state nil)
+ (when (and state (stringp status)
+ (not (string-prefix-p "finished" status)))
+ (let* ((map (plist-get state :map))
+ (root (plist-get state :root))
+ (prior (plist-get state :prior))
+ (current (and (boundp map) (gethash root (symbol-value map)))))
+ (when (and root prior (boundp map)
+ (not (equal prior current)))
+ (puthash root prior (symbol-value map)))))))
+
+(defun cj/--projectile-around-revert (map-symbol orig-fn &rest args)
+ "Around-advice for projectile cmd-runners.
+MAP-SYMBOL identifies which cmd-map to capture (compile / test / run).
+Captures the prior cached cmd, installs the one-shot revert-on-failure
+hook, then invokes ORIG-FN with ARGS."
+ (cj/--projectile-capture-cmd map-symbol)
+ (add-hook 'compilation-finish-functions #'cj/--projectile-revert-on-fail)
+ (apply orig-fn args))
+
+(defun cj/projectile-reset-cmds ()
+ "Clear projectile's cached compile/test/run cmds for the current project.
+Use when projectile's auto-detected default was wrong to begin with and
+you want to start fresh — the next F4 / F6 invocation will re-derive
+projectile's project-type default."
+ (interactive)
+ (let ((root (cj/--f4-project-root)))
+ (unless root
+ (user-error "F-keys: no project detected"))
+ (dolist (map '(projectile-compile-cmd-map
+ projectile-test-cmd-map
+ projectile-run-cmd-map))
+ (when (boundp map)
+ (remhash root (symbol-value map))))
+ (message "Cleared projectile compile/test/run cache for %s" root)))
+
;; ---------- F6 language detection ----------
(defconst cj/--f6-extension-language-map
@@ -368,8 +442,27 @@ message."
('interpreted (message "M-F4: not a compiled language"))
(_ (message "M-F4: no project detected")))))
+;; ---------- Projectile advice ----------
+
+(advice-add 'projectile-compile-project :around
+ (apply-partially #'cj/--projectile-around-revert
+ 'projectile-compile-cmd-map))
+(advice-add 'projectile-test-project :around
+ (apply-partially #'cj/--projectile-around-revert
+ 'projectile-test-cmd-map))
+(advice-add 'projectile-run-project :around
+ (apply-partially #'cj/--projectile-around-revert
+ 'projectile-run-cmd-map))
+
;; ---------- Bindings ----------
+(eval-when-compile (defvar cj/custom-keymap)) ;; defined in keybindings.el
+
+;; Skip the binding if cj/custom-keymap isn't loaded yet (e.g. when this
+;; module is required directly in batch tests).
+(when (boundp 'cj/custom-keymap)
+ (keymap-set cj/custom-keymap "P" #'cj/projectile-reset-cmds))
+
(keymap-global-set "<f4>" #'cj/f4-compile-and-run)
(keymap-global-set "C-<f4>" #'cj/f4-compile-only)
(keymap-global-set "M-<f4>" #'cj/f4-clean-rebuild)