Handle default/parse

Author: plexus

CHANGELOG.md

@@ -1,10 +1,14 @@
 # Unreleased
 
-## Added
-
-## Fixed
+Much expanded and improved version, see README for all details. This is
+approaching the envisioned scope for this library.
 
-## Changed
+- take docstring/command from var
+- `:strict?` mode
+- `:handler` and `:middleware` on flags
+- Much improved help text rendering
+- More lenient flag parsing
+- Add `:default` and `:parse`
 
 # 0.2.11-alpha (2024-02-08 / 0a352bc)
 
@@ -24,4 +28,4 @@
 
 - subcommand handling 
 - rudimentary flag handling
-- help text generation
+- help text generation

README.md

@@ -161,6 +161,10 @@ At this point a few things are worth calling out.
 - You can use the `--[no-]foo` syntax for adding both a `--foo` and a `--no-foo`
   flag, in this case the resulting value in the opts map will be `:foo true` or
   `:foo false`
+- You can add a `:default` to a flag, like `["--port PORT" {:default 8080}]`
+- You can set a `:parse` function which will be used to parse/coerce the
+  argument. The default will parse numbers (basic longs and doubles, no special
+  formats), and nothing else.
 
 You can also explicitly set which key to use with `:key`, as well as setting a
 specific `:value`, for instance:

bin/cli-test

@@ -45,12 +45,11 @@
  {:commands
   ["ls" {:command #'list-widgets
          :flags
-         ["-l, --long"
+         ["--port PORT" {:doc  "Port number"
+                         :default 8080}
+          "-l, --long"
           {:doc        "Use long format"
-           :middleware [(fn [cmd]
-                          (fn [opts]
-                            (binding [*format* :long]
-                              (cmd opts))))]}]}]})
+           }]}]})
 #_
 (cli/dispatch
  {:name    "cli-test"

src/lambdaisland/cli.clj

@@ -109,11 +109,21 @@
      (apply update flags (:key flagspec) f args))
    flagspec))
 
+(defn default-parse [s]
+  (cond
+    (re-find #"^-?\d+$" s)
+    (parse-long s)
+    (re-find #"^-?\d+\.\d+$" s)
+    (parse-double s)
+    :else
+    s))
+
 (defn handle-flag [{:keys [flagmap strict?] :as cmdspec} flag cli-args args flags]
   (reduce
    (fn [[cli-args args flags] f]
      (let [[f arg] (str/split f #"=")]
-       (if-let [{:keys [argcnt value handler middleware] :as flagspec} (get flagmap f)]
+       (if-let [{:keys [argcnt value handler middleware parse] :as flagspec
+                 :or {parse default-parse}} (get flagmap f)]
          (cond
            (or (nil? argcnt)
                (= 0 argcnt))
@@ -122,10 +132,10 @@
                             (update-flag flags flagspec (fnil inc 0)))]
            (= 1 argcnt)
            (if arg
-             [cli-args args (assoc-flag flags flagspec arg)]
-             [(next cli-args) args (assoc-flag flags flagspec (first cli-args))])
+             [cli-args args (assoc-flag flags flagspec (parse arg))]
+             [(next cli-args) args (assoc-flag flags flagspec (parse (first cli-args)))])
            :else
-           [(drop argcnt cli-args) args (assoc-flag flags flagspec (take argcnt cli-args))])
+           [(drop argcnt cli-args) args (assoc-flag flags flagspec (map parse (take argcnt cli-args)))])
          (if strict?
            (parse-error! "Unknown flag: " f)
            [cli-args args (update-flag flags {:key (keyword (str/replace f #"^-+" ""))} #(or arg ((fnil inc 0) %)))]))))
@@ -238,7 +248,10 @@
          cmdspec                  (assoc cmdspec :flagpairs flagpairs :flagmap flagmap)
          [cmdspec pos-args flags] (split-flags cmdspec cli-args)
          flagpairs                (get cmdspec :flagpairs)]
-     (dispatch (merge (meta (:command cmdspec)) cmdspec) pos-args flags)))
+     (dispatch (merge (meta (:command cmdspec)) cmdspec) pos-args (merge (reduce #(if-let [d (:default %2)]
+                                                                                    (assoc %1 (:key %2) d)
+                                                                                    %1) {} (map second flagpairs))
+                                                                         flags))))
   ([{:keys        [commands doc argnames command flags flagpairs flagmap]
      :as          cmdspec
      program-name :name