Merge pull request #58 from hlship/hls/20251028-command-path-in-group-help

hlship · web-flow · commit 4fa448260430 · 2025-10-28T11:41:04.000-07:00
Include the tool name in group help
diff --git a/src/net/lewisship/cli_tools/impl.clj b/src/net/lewisship/cli_tools/impl.clj
@@ -29,12 +29,12 @@
 (defn- compose-command-path
   [tool-name command-path]
   (when tool-name
-    [:bold.green
-     tool-name
-     (when (seq command-path)
-       (list
-         " "
-         (string/join " " command-path)))]))
+    (list
+      [(style :tool-name) tool-name]
+      (when (seq command-path)
+        (list " "
+              [(style :command-path)
+               (string/join " " command-path)])))))
 
 (defn command-path
   []
@@ -751,7 +751,8 @@
                                      (reduce max 0)))]
     (when container-map
       (pout (when recurse? "\n")
-            [(style :command) (string/join " " (:command-path container-map))]
+            (compose-command-path (:tool-name *tool-options*)
+                                  (:command-path container-map))
             " - "
             (or (some-> container-map :group-doc cleanup-docstring)
                 (missing-doc))))
diff --git a/test-resources/excess-values.txt b/test-resources/excess-values.txt
@@ -1 +1 @@
-[0;31mError in [0;32;1mharness collect[0;31m: Unexpected argument 'the-extra'[m
+[0;31mError in [0;32;1mharness[0;31m [0;32;1mcollect[0;31m: Unexpected argument 'the-extra'[m
diff --git a/test-resources/help-incomplete-nested.txt b/test-resources/help-incomplete-nested.txt
@@ -1 +1 @@
-[0;32;1mgroup-test: group nested[m is incomplete; [0;32;1mbutterfly[m or [0;32;1mleaf[m could follow; use [0;32;1mgroup-test group nested[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands
+[0;32;1mgroup-test: group nested[m is incomplete; [0;32;1mbutterfly[m or [0;32;1mleaf[m could follow; use [0;32;1mgroup-test[m [0;32;1mgroup nested[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands
diff --git a/test-resources/help-incomplete.txt b/test-resources/help-incomplete.txt
@@ -1 +1 @@
-[0;32;1mgroup-test: group[m is incomplete; [0;32;1mecho[m, [0;32;1medit[m, or [0;32;1mnested[m could follow; use [0;32;1mgroup-test group[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands
+[0;32;1mgroup-test: group[m is incomplete; [0;32;1mecho[m, [0;32;1medit[m, or [0;32;1mnested[m could follow; use [0;32;1mgroup-test[m [0;32;1mgroup[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands
diff --git a/test-resources/insufficient-values.txt b/test-resources/insufficient-values.txt
@@ -1 +1 @@
-[0;31mError in [0;32;1mharness collect[0;31m: No value for required argument VAL[m
+[0;31mError in [0;32;1mharness[0;31m [0;32;1mcollect[0;31m: No value for required argument VAL[m
diff --git a/test-resources/let-directive.txt b/test-resources/let-directive.txt
@@ -1 +1 @@
-[0;31mError in [0;32;1mharness set-mode[0;31m: Failed to validate "-m unknown": Must be one of async, batch, real-time[m
+[0;31mError in [0;32;1mharness[0;31m [0;32;1mset-mode[0;31m: Failed to validate "-m unknown": Must be one of async, batch, real-time[m
diff --git a/test-resources/messy-full-help.txt b/test-resources/messy-full-help.txt
@@ -10,7 +10,7 @@ Commands:
    messy: Messy command
   simple: Simple command
 
-messy - Messy command and group at same time
+bigmess messy - Messy command and group at same time
 
 Commands:
   nested: Command nested under messy group/command
diff --git a/test-resources/pos-arg-validation-failure.txt b/test-resources/pos-arg-validation-failure.txt
@@ -1 +1 @@
-[0;31mError in [0;32;1mharness configure[0;31m: HOST: must be a URL[m
+[0;31mError in [0;32;1mharness[0;31m [0;32;1mconfigure[0;31m: HOST: must be a URL[m
diff --git a/test-resources/sub-group-help.txt b/test-resources/sub-group-help.txt
@@ -1,4 +1,4 @@
-[0;1mgroup[m - Grouped commands
+[0;32;1mgroup-test[m [0;32;1mgroup[m - Grouped commands
 
 Commands:
     [0;32;1mecho[m: Echo a string
diff --git a/test-resources/tool-help-group-full.txt b/test-resources/tool-help-group-full.txt
@@ -9,7 +9,7 @@ Commands:
      [0;32;1mgroup[m: [0;3mThis provides the default documentation for the entire group[m
       [0;32;1mhelp[m: List available commands
 
-[0;1mgroup[m - This provides the default documentation for the entire group.
+[0;32;1mtest-harness[m [0;32;1mgroup[m - This provides the default documentation for the entire group.
 
 The full doc may span multiple lines.
 
diff --git a/test-resources/tool-help-grouped.txt b/test-resources/tool-help-grouped.txt
@@ -11,14 +11,14 @@ Commands:
       [0;32;1mgroup[m: [0;3mGrouped commands[m
        [0;32;1mhelp[m: List available commands
 
-[0;1mgroup[m - Grouped commands
+[0;32;1mgroup-test[m [0;32;1mgroup[m - Grouped commands
 
 Commands:
        [0;32;1mecho[m: Echo a string
        [0;32;1medit[m: Edit a whatever
      [0;32;1mnested[m: [0;3mNested commands inside group[m
 
-[0;1mgroup nested[m - Nested commands inside group
+[0;32;1mgroup-test[m [0;32;1mgroup nested[m - Nested commands inside group
 
 Commands:
   [0;32;1mbutterfly[m: Nested command butterfly
diff --git a/test-resources/unknown-option.txt b/test-resources/unknown-option.txt
@@ -1,3 +1,3 @@
-[0;31mErrors in [0;32;1mharness configure[0;31m:
+[0;31mErrors in [0;32;1mharness[0;31m [0;32;1mconfigure[0;31m:
   Unknown option: "--debug"
   No value for required argument HOST[m
diff --git a/test/net/lewisship/abort_test.clj b/test/net/lewisship/abort_test.clj
@@ -15,9 +15,12 @@
 (deftest abort-with-message
   (binding [ansi/*color-enabled* true]
     (is (match? {:status 1
-                 :err    (compose [:bold.green "tool category command"] ": base message" "\n")}
+                 :err    (compose [:bold.green "tool"]
+                                  " "
+                                  [:bold.green "category command"]
+                                  ": base message" "\n")}
                 (capture-result
-                      (abort (command-path) ": " "base message"))))))
+                  (abort (command-path) ": " "base message"))))))
 
 
 (deftest abort-with-several-messages
diff --git a/test/net/lewisship/cli_tools/bb_test.clj b/test/net/lewisship/cli_tools/bb_test.clj
@@ -19,7 +19,11 @@
 (deftest can-find-cli-commands
   (is (match?
         {:status 0
-         :out    "bb - BB CLI commands\n\nCommands:\n  alpha: This command take a symbol and a long\n   find: Find by id\n"}
+         :out-lines ["bb-cli bb - BB CLI commands"
+                     ""
+                     "Commands:"
+                     "  alpha: This command take a symbol and a long"
+                     "   find: Find by id"]}
         (dispatch "bb" "-h"))))
 
 (deftest can-invoke-command-with-default-name
diff --git a/test/net/lewisship/cli_tools_test.clj b/test/net/lewisship/cli_tools_test.clj
@@ -20,6 +20,15 @@
                                    :cache-dir nil}]
       (f))))
 
+(defn- capture
+  "Used when output changes to capture new output (the embedded ANSI sequences are hard to work with."
+  ([file result]
+   (capture file :out result))
+  ([file k result]
+   (let [content (get result k)]
+     (print content)
+     (spit (str "test-resources/" file ".txt") content))))
+
 ;; An example to test around
 
 (defcommand configure
@@ -216,9 +225,9 @@
   (is (match? {:status 0
                :out    (slurp "test-resources/tool-help-group-full.txt")}
               (dispatch-with-result {:tool-name "test-harness"
-                         :groups
-                         {"group" {:namespaces '[net.lewisship.group-default-ns
-                                                 net.lewisship.example-ns]}}
+                                     :groups
+                                     {"group" {:namespaces '[net.lewisship.group-default-ns
+                                                             net.lewisship.example-ns]}}
                                      :arguments ["help" "-c" "all"]}))))
 
 (deftest help-with-search-term

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[0;31mError in [0;32;1mharness collect[0;31m: Unexpected argument 'the-extra'[m`
	`1`	`+[0;31mError in [0;32;1mharness[0;31m [0;32;1mcollect[0;31m: Unexpected argument 'the-extra'[m`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[0;32;1mgroup-test: group nested[m is incomplete; [0;32;1mbutterfly[m or [0;32;1mleaf[m could follow; use [0;32;1mgroup-test group nested[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands`
	`1`	`+[0;32;1mgroup-test: group nested[m is incomplete; [0;32;1mbutterfly[m or [0;32;1mleaf[m could follow; use [0;32;1mgroup-test[m [0;32;1mgroup nested[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[0;32;1mgroup-test: group[m is incomplete; [0;32;1mecho[m, [0;32;1medit[m, or [0;32;1mnested[m could follow; use [0;32;1mgroup-test group[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands`
	`1`	`+[0;32;1mgroup-test: group[m is incomplete; [0;32;1mecho[m, [0;32;1medit[m, or [0;32;1mnested[m could follow; use [0;32;1mgroup-test[m [0;32;1mgroup[m [0;32;1m--help[m (or [0;32;1m-h[m) to list commands`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[0;31mError in [0;32;1mharness set-mode[0;31m: Failed to validate "-m unknown": Must be one of async, batch, real-time[m`
	`1`	`+[0;31mError in [0;32;1mharness[0;31m [0;32;1mset-mode[0;31m: Failed to validate "-m unknown": Must be one of async, batch, real-time[m`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-[0;31mError in [0;32;1mharness configure[0;31m: HOST: must be a URL[m`
	`1`	`+[0;31mError in [0;32;1mharness[0;31m [0;32;1mconfigure[0;31m: HOST: must be a URL[m`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-[0;1mgroup[m - Grouped commands`
	`1`	`+[0;32;1mgroup-test[m [0;32;1mgroup[m - Grouped commands`
`2`	`2`
`3`	`3`	`Commands:`
`4`	`4`	`[0;32;1mecho[m: Echo a string`
-Original file line number
+Diff line change
      [0;32;1mgroup[m: [0;3mThis provides the default documentation for the entire group[m
       [0;32;1mhelp[m: List available commands
 -[0;1mgroup[m - This provides the default documentation for the entire group.
 +[0;32;1mtest-harness[m [0;32;1mgroup[m - This provides the default documentation for the entire group.
 The full doc may span multiple lines.