aboutsummaryrefslogtreecommitdiff
path: root/tests/test-dev-fkeys--f4-compile-and-run.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-03 16:13:21 -0500
committerCraig Jennings <c@cjennings.net>2026-05-03 16:13:21 -0500
commit293227f755d576f89d09f41fb3bc50fa2a0a1b8d (patch)
tree18e29893a2a8b5efd30d9d2270e46d17df6eb0f9 /tests/test-dev-fkeys--f4-compile-and-run.el
parent83ed8a653fc988e3c27106e5e27c8f63e475fb63 (diff)
downloaddotemacs-293227f755d576f89d09f41fb3bc50fa2a0a1b8d.tar.gz
dotemacs-293227f755d576f89d09f41fb3bc50fa2a0a1b8d.zip
feat(dev-fkeys): add project-aware F4 compile/run dispatcher
I added a new module `modules/dev-fkeys.el` that owns the dev F-key block. F4 prompts via `completing-read` with a candidate set filtered by project type (compiled / interpreted / unknown). C-F4 is the compile-only fast path. M-F4 is clean + rebuild. It runs a heuristic clean command derived from the project markers (go.mod, Cargo.toml, Eask, Makefile, CMakeLists.txt) and chains `projectile-compile-project` on success. S-F4 stays on `recompile` and now lives globally instead of duplicated across prog-general.el and prog-c.el. F6 is bound globally to `projectile-test-project` as a Phase 1 stopgap. Phase 2 replaces it with the polyglot test runner spec'd in todo.org. Project-type detection runs against the projectile root and falls back to `unknown` when no marker matches. Interpreted markers are checked first so a Python or Node project with a Makefile for tasks classifies as interpreted instead of compiled. Compile + Run sequencing uses a one-shot `compilation-finish-functions` hook that self-removes on first invocation and only fires the follow-up when the status string starts with `finished`. Cleanup in the same commit: - Dropped F4/F5/F6 from `prog-general.el`'s prog-mode-hook. They are now global. - Dropped F6→format bindings from prog-c.el / prog-python.el / prog-shell.el. C-; f was already bound in each, so this is pure removal. - Dropped the duplicate S-F4 from prog-c.el. The global binding covers it. - Updated the keybinding header in prog-general.el and the workflow comments in prog-c.el / prog-shell.el. - Wired `(require 'dev-fkeys)` in init.el alongside coverage-core. TDD: 73 tests across 11 files, one per helper. Production code is split into small testable internals (`cj/--detect-project-type`, `cj/--f4-candidates`, `cj/--f4-derive-clean-cmd`, `cj/--f4-make-once-hook`, `cj/--f4-dispatch`, `cj/--f4-compile-and-run-impl`, `cj/--f4-clean-rebuild-impl`, `cj/--f4-project-root`) plus three thin interactive wrappers. Smoke tests confirm bindings register on load. Known limitation: if another `compilation-finish-functions` hook fires between my add-hook and the compile finishing, the chain can fire on the wrong compile. The hook self-removes on first invocation regardless of which compile it sees. Documented in the impl docstring. Acceptable for v1. Phase 2 will replace F6 with the polyglot test runner (tree-sitter queries for Python/Go/TS, sexp scan for Elisp, buffer-local last-test memory).
Diffstat (limited to 'tests/test-dev-fkeys--f4-compile-and-run.el')
-rw-r--r--tests/test-dev-fkeys--f4-compile-and-run.el94
1 files changed, 94 insertions, 0 deletions
diff --git a/tests/test-dev-fkeys--f4-compile-and-run.el b/tests/test-dev-fkeys--f4-compile-and-run.el
new file mode 100644
index 00000000..3e0da877
--- /dev/null
+++ b/tests/test-dev-fkeys--f4-compile-and-run.el
@@ -0,0 +1,94 @@
+;;; test-dev-fkeys--f4-compile-and-run.el --- Smoke tests for cj/f4-compile-and-run -*- lexical-binding: t -*-
+
+;;; Commentary:
+;; Smoke tests for the interactive F4 wrapper. The wrapper:
+;;
+;; 1. Resolves the project root.
+;; 2. Detects project type from markers.
+;; 3. Builds the candidate list.
+;; 4. Prompts via completing-read.
+;; 5. Looks up the chosen label's action.
+;; 6. Dispatches.
+;;
+;; Per the elisp-testing rule on Interactive vs Internal split, the heavy
+;; lifting is in `cj/--f4-dispatch' and the helpers — those are tested
+;; directly in their own files. This file just confirms the wrapper wires
+;; the pieces together: prompt fires, the chosen label routes to the right
+;; action symbol.
+
+;;; Code:
+
+(require 'ert)
+(require 'cl-lib)
+(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
+(require 'dev-fkeys)
+
+(defmacro test-dev-fkeys-f4--with-project (markers &rest body)
+ "Set up a temp project with MARKERS, bind ROOT, run BODY, clean up."
+ (declare (indent 1))
+ `(let ((root (make-temp-file "test-dev-fkeys-f4-" t)))
+ (unwind-protect
+ (progn
+ (dolist (marker ,markers)
+ (write-region "" nil (expand-file-name marker root)))
+ ,@body)
+ (delete-directory root t))))
+
+;;; Normal Cases
+
+(ert-deftest test-dev-fkeys-f4-compile-and-run-prompts-with-completing-read ()
+ "Normal: the wrapper invokes completing-read with the project's candidate labels.
+
+Components integrated:
+- `cj/f4-compile-and-run' (unit under test)
+- `cj/--f4-project-root' (MOCKED — returns the temp project root)
+- `cj/--detect-project-type' (real)
+- `cj/--f4-candidates' (real)
+- `completing-read' (MOCKED — captures candidates and returns the default)
+- `cj/--f4-dispatch' (MOCKED — captures the action it received)"
+ (test-dev-fkeys-f4--with-project '("go.mod")
+ (let (seen-candidates seen-action)
+ (cl-letf (((symbol-function 'cj/--f4-project-root) (lambda () root))
+ ((symbol-function 'completing-read)
+ (lambda (_prompt collection &rest _)
+ (setq seen-candidates collection)
+ (car collection)))
+ ((symbol-function 'cj/--f4-dispatch)
+ (lambda (action) (setq seen-action action))))
+ (cj/f4-compile-and-run)
+ ;; Compiled-project candidates are the four labels.
+ (should (member "Compile + Run" seen-candidates))
+ (should (member "Compile" seen-candidates))
+ (should (member "Run" seen-candidates))
+ (should (member "Clean + Rebuild" seen-candidates))
+ ;; Default (first label) is "Compile + Run", which routes to
+ ;; the compile-and-run action.
+ (should (eq seen-action 'compile-and-run))))))
+
+(ert-deftest test-dev-fkeys-f4-compile-and-run-routes-chosen-label-to-action ()
+ "Normal: a non-default label selection routes to the right action."
+ (test-dev-fkeys-f4--with-project '("Cargo.toml")
+ (let (seen-action)
+ (cl-letf (((symbol-function 'cj/--f4-project-root) (lambda () root))
+ ((symbol-function 'completing-read)
+ (lambda (&rest _) "Run"))
+ ((symbol-function 'cj/--f4-dispatch)
+ (lambda (action) (setq seen-action action))))
+ (cj/f4-compile-and-run)
+ (should (eq seen-action 'run-only))))))
+
+(ert-deftest test-dev-fkeys-f4-compile-and-run-interpreted-project-shows-run-only ()
+ "Normal: an interpreted project's menu has only the Run candidate."
+ (test-dev-fkeys-f4--with-project '("pyproject.toml")
+ (let (seen-candidates)
+ (cl-letf (((symbol-function 'cj/--f4-project-root) (lambda () root))
+ ((symbol-function 'completing-read)
+ (lambda (_prompt collection &rest _)
+ (setq seen-candidates collection)
+ (car collection)))
+ ((symbol-function 'cj/--f4-dispatch) (lambda (_action) nil)))
+ (cj/f4-compile-and-run)
+ (should (equal seen-candidates '("Run")))))))
+
+(provide 'test-dev-fkeys--f4-compile-and-run)
+;;; test-dev-fkeys--f4-compile-and-run.el ends here