Always display short options before long ones in help screens, even i…

…f specified otherwise when defining.

eldev.el

@@ -1921,7 +1921,9 @@ If COMMAND is nil, list global options instead."
       (eldev-output (or title "\nOptions:"))
       (dolist (group by-handler)
         (let* ((value-mode  (eldev-get (car group) :option-value))
-               (options     (cdr group))
+               ;; Sort short options before long ones (but usually they are already sorted).
+               (options     (sort (copy-sequence (cdr group))
+                                  (lambda (a b) (and (not (string-prefix-p "--" (symbol-name a))) (string-prefix-p "--" (symbol-name b))))))
                (all-strings (mapconcat #'symbol-name options ", ")))
           (when (eldev-all-p (string-prefix-p "--" (symbol-name it)) options)
             (setf all-strings (concat "    " all-strings)))

test/help.el

@@ -35,4 +35,16 @@
     (should (= exit-code 0))))
 
 
+(eldev-ert-defargtest eldev-help-sorts-option (short-first)
+                      (nil t)
+  (eldev--test-run "empty-project" ("--setup" `(eldev-defoption eldev--test-custom-option ()
+                                                 "Only for testing"
+                                                 :options     ,(if short-first '(-X --custom-option) '(--custom-option -X))
+                                                 :for-command help)
+                                    "help" "help")
+    ;; Should sort short options first, even if (accidentally) specified otherwise when defining.
+    (should (string-match-p "-X, --custom-option" stdout))
+    (should (= exit-code 0))))
+
+
 (provide 'test/help)