Merge branch 'fix-readme' into 'master'

Fix use-package example in README

See merge request jessieh/mood-line!14

README.md

@@ -82,7 +82,7 @@ If you'd like to see prettier Unicode glyphs, you can change the value of `mood-
 
 ```elisp
 ;; The default set of glyphs:
-;;   * myModifiedFile.js  Replace*3                 + main  Javascript  ! Issues: 2
+;;   * myModifiedFile.js  Replace*3                 + main  JavaScript  ! Issues: 2
 (setq mood-line-glyph-alist mood-line-glyphs-ascii)
 
 ;; A set of Fira Code-compatible Unicode glyphs:
@@ -112,7 +112,7 @@ To run the included tests:
 ## Feedback
 
 If you experience any issues with this package, please
-[open an issue](https://gitlab.com/jessieh/mood-line/issues/new)
+[open an issue](https://git.tty.dog/jessieh/mood-line/issues/new)
 on the issue tracker.
 
 Suggestions for improvements and feature requests are always appreciated, as well!

mood-line-segment-checker.el

@@ -35,7 +35,7 @@
 ;; -------------------------------------------------------------------------- ;;
 
 ;; ---------------------------------- ;;
-;; Compile time requirements
+;; Required features
 ;; ---------------------------------- ;;
 
 (eval-when-compile
@@ -45,19 +45,19 @@
 ;; External variable defs
 ;; ---------------------------------- ;;
 
-(defvar flycheck-current-errors)
+(eval-when-compile
+  (defvar flycheck-current-errors))
 
 ;; ---------------------------------- ;;
 ;; External function decls
 ;; ---------------------------------- ;;
 
-(declare-function mood-line--get-glyph "mood-line")
-
-(declare-function flycheck-count-errors "flycheck")
-
-(declare-function flymake-running-backends "flymake")
-(declare-function flymake-reporting-backends "flymake")
-(declare-function flymake--lookup-type-property "flymake")
+(eval-when-compile
+  (declare-function mood-line--get-glyph "mood-line")
+  (declare-function flycheck-count-errors "flycheck")
+  (declare-function flymake-running-backends "flymake")
+  (declare-function flymake-reporting-backends "flymake")
+  (declare-function flymake--lookup-type-property "flymake"))
 
 ;; -------------------------------------------------------------------------- ;;
 ;;

mood-line-segment-indentation.el

@@ -39,7 +39,8 @@
 ;; External function decls
 ;; ---------------------------------- ;;
 
-(declare-function mood-line--get-glyph "mood-line")
+(eval-when-compile
+  (declare-function mood-line--get-glyph "mood-line"))
 
 ;; -------------------------------------------------------------------------- ;;
 ;;

mood-line-segment-vc.el

@@ -38,7 +38,8 @@
 ;; External function decls
 ;; ---------------------------------- ;;
 
-(declare-function mood-line--get-glyph "mood-line")
+(eval-when-compile
+  (declare-function mood-line--get-glyph "mood-line"))
 
 ;; -------------------------------------------------------------------------- ;;
 ;;

mood-line.el

@@ -10,8 +10,7 @@
 
 ;;; Commentary:
 ;;
-;; mood-line is a minimal mode line configuration that aims to replicate
-;; some of the features of the more advanced doom-modeline package.
+;; mood-line is a lightweight, drop-in replacement for the default mode line.
 ;;
 ;; Features offered:
 ;; * Clean, informative design
@@ -52,7 +51,7 @@
 ;; -------------------------------------------------------------------------- ;;
 
 ;; ---------------------------------- ;;
-;; Compile time requirements
+;; Required features
 ;; ---------------------------------- ;;
 
 (eval-when-compile
@@ -62,18 +61,19 @@
 ;; External variable defs
 ;; ---------------------------------- ;;
 
-(defvar anzu--cached-count)
-(defvar anzu--current-position)
-(defvar anzu--overflow-p)
-(defvar anzu--total-matched)
+(eval-when-compile
+  (defvar anzu--cached-count)
+  (defvar anzu--current-position)
+  (defvar anzu--overflow-p)
+  (defvar anzu--total-matched))
 
 ;; ---------------------------------- ;;
 ;; External function decls
 ;; ---------------------------------- ;;
 
-(declare-function mc/num-cursors "multiple-cursors")
-
-(declare-function string-blank-p "subr-x")
+(eval-when-compile
+  (declare-function mc/num-cursors "multiple-cursors")
+  (declare-function string-blank-p "subr-x"))
 
 ;; -------------------------------------------------------------------------- ;;
 ;;

test/mood-line-test.el

@@ -17,57 +17,80 @@
 ;; mood-line-defformat
 ;; ---------------------------------- ;;
 
-(ert-deftest -defformat/right-nil ()
-  "The format sequence should expand if the right segment list is not provided."
-  (should (equal (mood-line-defformat
-                  ;; Left
-                  ("XYZ")
-                  ;; Right
-                  )
+(ert-deftest -defformat/padding ()
+  "The expanded sequence should include the provided (or default) padding."
+  (should (equal (mood-line-defformat)
                  (list
                   ;; Left
-                  '("XYZ")
+                  '(" ")
                   ;; Right
-                  nil))))
-
-(ert-deftest -defformat/left-right ()
-  "The expanded sequence should should include left and right segments lists."
+                  '(" "))))
   (should (equal (mood-line-defformat
+                  :padding
+                  "---")
+                 (list
                   ;; Left
-                  ("ABC")
+                  '("---")
                   ;; Right
+                  '("---")))))
+
+(ert-deftest -defformat/left-right-nil ()
+  "The format sequence should expand if the left or right segment list is nil."
+  (should (equal (mood-line-defformat
+                  :left
                   ("XYZ"))
                  (list
                   ;; Left
-                  '("ABC")
+                  '(" " "XYZ")
                   ;; Right
-                  '("XYZ")))))
+                  '(" "))))
+  (should (equal (mood-line-defformat
+                  :right
+                  ("XYZ"))
+                 (list
+                  ;; Left
+                  '(" ")
+                  ;; Right
+                  '("XYZ" " ")))))
+
+(ert-deftest -defformat/left-right ()
+  "The expanded sequence should include left and right segments lists."
+  (should (equal (mood-line-defformat
+                  :left
+                  ("ABC")
+                  :right
+                  ("XYZ"))
+                 (list
+                  ;; Left
+                  '(" " "ABC")
+                  ;; Right
+                  '("XYZ" " ")))))
 
 (ert-deftest -defformat/cons-cells ()
   "Cons cell segments should expand into their `car' and `cdr' values."
   (should (equal (mood-line-defformat
-                  ;; Left
+                  :left
                   ("ABC" ("ABC" . "XYZ") "XYZ")
-                  ;; Right
+                  :right
                   ("..." ((some-fn) . " ") "..."))
                  (list
                   ;; Left
-                  '("ABC" "ABC" "XYZ" "XYZ")
+                  '(" " "ABC" "ABC" "XYZ" "XYZ")
                   ;; Right
-                  '("..." (some-fn) " " "...")))))
+                  '("..." (some-fn) " " "..." " ")))))
 
 (ert-deftest -defformat/exp-separators ()
   "Non-string, non-cons expressions should expand followed by a blank string."
   (should (equal (mood-line-defformat
-                  ;; Left
+                  :left
                   ("ABC" ("ABC" . "XYZ") some-exp "XYZ" (some-fn))
-                  ;; Right
+                  :right
                   ("..." ((some-fn) . " ") (another-fn) "..."))
                  (list
                   ;; Left
-                  '("ABC" "ABC" "XYZ" some-exp "" "XYZ" (some-fn) "")
+                  '(" " "ABC" "ABC" "XYZ" some-exp "" "XYZ" (some-fn) "")
                   ;; Right
-                  '("..." (some-fn) " " (another-fn) "" "...")))))
+                  '("..." (some-fn) " " (another-fn) "" "..." " ")))))
 
 ;; -------------------------------------------------------------------------- ;;
 ;;