Skip to content

Cmd key guard #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
borkdude merged 2 commits into from
Jul 23, 2026
Merged

Cmd key guard #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ca6a21
Reject a :cmd key that is not a string, symbol or keyword
borkdude Jul 23, 2026
0659c64
Shorten error
borkdude Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/babashka/cli.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1291,6 +1291,11 @@
(when (:cmds node)
(throw (ex-info "A tree node contains :cmds (table entry syntax): nest children under :cmd, or pass a table (vector of entries)"
{:node node})))
#?(:squint nil :cljd nil :default
(doseq [k (if (vector? (:cmd node)) (map first (:cmd node)) (keys (:cmd node)))]
(when-not (or (string? k) (symbol? k) (keyword? k))
(throw (ex-info (str "Command name " (pr-str k) " is not a string, symbol or keyword")
{:node node :key k})))))
(let [;; a vector `:cmd` (pairs `[[name child] ...]`) preserves child order without
;; relying on map iteration order; fold it into the lookup map + `::cmd-order`
node (if (vector? (:cmd node))
Expand Down
7 changes: 7 additions & 0 deletions test/babashka/cli_test.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -781,6 +781,13 @@
(take-while #(str/starts-with? % " "))
(mapv #(str/trim %)))))))))

#?(:squint nil :cljd nil :default
(deftest cmd-key-guard-test
(testing "a :cmd key that is not a name throws with an explanation"
(is (thrown-with-msg?
Exception #"is not a string, symbol or keyword"
(cli/dispatch {:cmd {identity {:fn identity}}} ["x"]))))))

(deftest dispatch-exec-fn-test
(testing ":exec-fn is called with just the parsed opts; :fn with the whole map"
(is (= {:foo 1 :bar true}
Expand Down