fix TCLI-100 by always showing defaults

Author: seancorfield

.gitignore

@@ -1,9 +1,11 @@
+/.calva/output-window
 /.clj-kondo/.cache
 /.cpcache
 /.lein-failures
 /.lein-repl-history
 /.lsp
 /.nrepl-port
 /.portal
+/.socket-repl-port
 /cljs-test-runner-out
 target

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+* Release 1.0.next in progress
+  * Document `:missing`, `:multi`, and `:post-validation` in the docstrings and in the README.
+  * In the help summary, display default values for all options that provide them [TCLI-100](https://clojure.atlassian.net/browse/TCLI-100). Previously, only options that had required arguments would have their defaults shown.
+
 * Release 1.0.206 2021-02-27
   * Allow validation to be performed either after parsing (before option processing) -- current default -- or after option processing, via the `:post-validation true` flag [TCLI-98](https://clojure.atlassian.net/browse/TCLI-98).
   * Allow validation message to be a function (of the invalid argument) in addition to being a plain string [TCLI-97](https://clojure.atlassian.net/browse/TCLI-97).

src/main/clojure/clojure/tools/cli.cljc

@@ -501,17 +501,17 @@
         opt (cond (and short-opt long-opt) (str short-opt ", " long-opt)
                   long-opt (str "    " long-opt)
                   short-opt short-opt)
-        [opt dd] (if required
-                   [(str opt \space required)
-                    (or default-desc
-                        (when (contains? spec :default)
-                          (if (some? default)
-                            (str default)
-                            "nil"))
-                        (when default-fn
-                          "<computed>")
-                        "")]
-                   [opt ""])]
+        [opt dd] [(if required
+                    (str opt \space required)
+                    opt)
+                  (or default-desc
+                      (when (contains? spec :default)
+                        (if (some? default)
+                          (str default)
+                          "nil"))
+                      (when default-fn
+                        "<computed>")
+                      "")]]
     (if show-defaults?
       [opt dd (or desc "")]
       [opt (or desc "")])))
@@ -541,9 +541,8 @@
   your user-supplied :summary-fn option) on the compiled option specs."
   [specs]
   (if (seq specs)
-    (let [show-defaults? (some #(and (:required %)
-                                     (or (contains? % :default)
-                                         (contains? % :default-fn))) specs)
+    (let [show-defaults? (some #(or (contains? % :default)
+                                    (contains? % :default-fn)) specs)
           parts (map (partial make-summary-part show-defaults?) specs)
           lens (apply map (fn [& cols] (apply max (map count cols))) parts)
           lines (format-lines lens parts)]

src/test/clojure/clojure/tools/cli_test.cljc

@@ -374,16 +374,16 @@
                  ["  -s, --server HOST    example.com  Upstream server"
                   "  -p, --port PORT      80           Upstream port number"
                   "  -o PATH                           Output file"
-                  "  -v                                Verbosity level; may be specified more than once"
+                  "  -v                   0            Verbosity level; may be specified more than once"
                   "      --ternary t|f|?  false        A ternary option defaulting to false"
                   "  -d, --[no-]daemon                 Daemonize the process"
                   "      --help"]))))
-  (testing "does not print :default column when no defaults will be shown"
+  (testing "prints :default column even when no default for required flag"
     (is (= (summarize (compile-option-specs [["-b" "--boolean" "A boolean option with a hidden default"
                                               :default true]
                                              ["-o" "--option ARG" "An option without a default"]]))
-           (join \newline ["  -b, --boolean     A boolean option with a hidden default"
-                           "  -o, --option ARG  An option without a default"]))))
+           (join \newline ["  -b, --boolean     true  A boolean option with a hidden default"
+                           "  -o, --option ARG        An option without a default"]))))
   (testing "works with no options"
     (is (= (summarize (compile-option-specs []))
            ""))))