aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-16 02:12:56 -0500
committerCraig Jennings <c@cjennings.net>2026-05-16 02:12:56 -0500
commit6d31076bee71461ad7ce1ebb82a5ea53eff6756d (patch)
tree29946b50f8ad3407549ec4ab734004ca19c098cf
parent64caeb3fc3b8e86ef1004d239f9da7443614e686 (diff)
downloaddotemacs-6d31076bee71461ad7ce1ebb82a5ea53eff6756d.tar.gz
dotemacs-6d31076bee71461ad7ce1ebb82a5ea53eff6756d.zip
feat(modeline): surface flycheck status in the custom modeline
The custom modeline builds `mode-line-format` from explicit segments and skips `minor-mode-alist`, so flycheck's lighter never appears. That hid error and warning counts even in buffers where flycheck was auto-enabling (every emacs-lisp and sh buffer). The fix is Option 4 from the design doc: customize the flycheck modeline variables, then add a single guarded `(:eval ...)` form to `mode-line-format`. Five new lines total, two-file change. `modules/flycheck-config.el` :custom block gets: (flycheck-mode-line-prefix "🐛") (flycheck-mode-success-indicator " ✓") `flycheck-mode-line-color` stays default-t so error / warning counts pick up their faces automatically. `modules/modeline-config.el` `mode-line-format` gets an `(:eval ...)` between the recording indicator and `cj/modeline-vc-branch`: (:eval (when (and (mode-line-window-selected-p) (bound-and-true-p flycheck-mode)) (flycheck-mode-line-status-text))) The `mode-line-window-selected-p` guard mirrors `cj/modeline-vc-branch` and `cj/modeline-misc-info` -- segments hide in inactive windows. The `bound-and-true-p flycheck-mode` guard keeps the form silent in buffers where flycheck hasn't loaded or isn't enabled, which is safer than referencing `flycheck-mode` directly. The `(:eval ...)` is inline rather than a named `defvar-local`, so no addition to the risky-local-variable list is needed. `tests/test-modeline-config-flycheck-segment.el` -- 3 smoke tests asserting the segment is present and both guards are in place. All existing tests stay green. Manual verification (per the design doc) is the user's call -- the emoji prefix and the colored count behavior need a running GUI Emacs to observe.
-rw-r--r--modules/flycheck-config.el5
-rw-r--r--modules/modeline-config.el7
-rw-r--r--tests/test-modeline-config-flycheck-segment.el36
3 files changed, 48 insertions, 0 deletions
diff --git a/modules/flycheck-config.el b/modules/flycheck-config.el
index 8c3e2a7b8..e6dfb25e2 100644
--- a/modules/flycheck-config.el
+++ b/modules/flycheck-config.el
@@ -56,6 +56,11 @@
(checkdoc-arguments
'(("sentence-end-double-space" nil)
("warn-escape" nil)))
+ ;; Modeline customization (rendered via mode-line-format in modeline-config.el).
+ ;; The count portion picks up `error' / `warning' faces because
+ ;; `flycheck-mode-line-color' stays t (the default).
+ (flycheck-mode-line-prefix "🐛")
+ (flycheck-mode-success-indicator " ✓")
:config
;; use the load-path of the currently running Emacs instance
diff --git a/modules/modeline-config.el b/modules/modeline-config.el
index 7fc755949..771d960f0 100644
--- a/modules/modeline-config.el
+++ b/modules/modeline-config.el
@@ -231,6 +231,13 @@ Shows only in active window.")
mode-line-format-right-align
(:eval (when (fboundp 'cj/recording-modeline-indicator)
(cj/recording-modeline-indicator)))
+ ;; Flycheck status: prefix + counts (or success indicator). Gated
+ ;; to the active window, and to buffers where flycheck has loaded
+ ;; and turned on, so the call is safe even before flycheck loads.
+ (:eval (when (and (mode-line-window-selected-p)
+ (bound-and-true-p flycheck-mode))
+ (flycheck-mode-line-status-text)))
+ " "
cj/modeline-vc-branch
" "
cj/modeline-misc-info
diff --git a/tests/test-modeline-config-flycheck-segment.el b/tests/test-modeline-config-flycheck-segment.el
new file mode 100644
index 000000000..208deaa72
--- /dev/null
+++ b/tests/test-modeline-config-flycheck-segment.el
@@ -0,0 +1,36 @@
+;;; test-modeline-config-flycheck-segment.el --- Flycheck segment in modeline -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;; Smoke test that the custom modeline's `mode-line-format' includes
+;; a guarded reference to `flycheck-mode-line-status-text', and that
+;; the guard requires both `mode-line-window-selected-p' and
+;; `bound-and-true-p flycheck-mode'. See
+;; docs/design/flycheck-modeline-customization.org for the design.
+
+;;; Code:
+
+(require 'ert)
+
+(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
+
+(require 'modeline-config)
+
+(ert-deftest test-modeline-config-flycheck-segment-present ()
+ "`mode-line-format' contains an :eval form invoking flycheck-mode-line-status-text."
+ (let ((printed (format "%S" (default-value 'mode-line-format))))
+ (should (string-match-p "flycheck-mode-line-status-text" printed))))
+
+(ert-deftest test-modeline-config-flycheck-segment-guarded-by-active-window ()
+ "Flycheck segment gates on `mode-line-window-selected-p'."
+ (let ((printed (format "%S" (default-value 'mode-line-format))))
+ (should (string-match-p "mode-line-window-selected-p" printed))))
+
+(ert-deftest test-modeline-config-flycheck-segment-guarded-by-flycheck-mode ()
+ "Flycheck segment gates on `bound-and-true-p flycheck-mode'.
+The `bound-and-true-p' guard makes the form safe in buffers where
+flycheck never loaded."
+ (let ((printed (format "%S" (default-value 'mode-line-format))))
+ (should (string-match-p "bound-and-true-p flycheck-mode" printed))))
+
+(provide 'test-modeline-config-flycheck-segment)
+;;; test-modeline-config-flycheck-segment.el ends here