clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-06-01 19:01:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: cli completion of aliases

Browse Source 
babashka.cli doesn't support -o=val completion for alias options e.g.
'-f=created-at'. Instead they now correctly complete '-f created-at'
This commit is contained in:
Gabriel Horner
2026-03-17 13:40:16 -04:00
parent d7d0e939a5
commit e6e8a945e8
2 changed files with 43 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
src/main/logseq/cli/completion_generator.cljs
View File

@@ -182,40 +182,42 @@ _logseq_multi_values() {
(string/replace "'" "'\\''")))
(defn- zsh-token-for
"Generate a zsh _arguments token string for a spec token descriptor.
"Generate zsh _arguments token strings for a spec token descriptor.
Returns a vector of one or two strings. Aliased value-taking options produce
separate long (--opt=) and short (-o+) specs so that -o=val is not suggested
(babashka.cli does not support = with short aliases).
no-prefix-keys: set of keys that get --no-<option> completions."
[{:keys [key type alias desc values complete]} no-prefix-keys]
(let [long-opt (zsh-option-name key)
desc* (zsh-escape-desc desc)
alias-short (when alias (str "-" (name alias)))]
alias-short (when alias (str "-" (name alias)))
;; Exclusion list shared by aliased value-option pairs
excl (when alias (str "(" alias-short " " long-opt ")"))]
(case type
:flag
(let [no-prefix? (contains? no-prefix-keys key)
no-opt (str "--no-" (name key))]
(if alias
(str "'" (str "(" alias-short " " long-opt (when no-prefix? (str " " no-opt)) ")") "'"
"{" alias-short "," long-opt "}"
"'[" desc* "]'")
(if no-prefix?
(str "'(" long-opt " " no-opt ")" long-opt "[" desc* "]'")
(str "'" long-opt "[" desc* "]'"))))
[(str "'" (str "(" alias-short " " long-opt (when no-prefix? (str " " no-opt)) ")") "'"
"{" alias-short "," long-opt "}"
"'[" desc* "]'")]
[(if no-prefix?
(str "'(" long-opt " " no-opt ")" long-opt "[" desc* "]'")
(str "'" long-opt "[" desc* "]'"))]))
:enum
(let [vals-str (string/join " " values)]
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:value:(" vals-str ")'")
(str "'" long-opt "=[" desc* "]:value:(" vals-str ")'"))
)
[(str "'" excl long-opt "=[" desc* "]:value:(" vals-str ")'")
(str "'" excl alias-short "[" desc* "]:value:(" vals-str ")'")]
[(str "'" long-opt "=[" desc* "]:value:(" vals-str ")'")]))
:multi
(let [vals-str (string/join " " values)]
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:value:{_logseq_multi_values " vals-str "}'")
(str "'" long-opt "=[" desc* "]:value:{_logseq_multi_values " vals-str "}'")))
[(str "'" excl long-opt "=[" desc* "]:value:{_logseq_multi_values " vals-str "}'")
(str "'" excl alias-short "[" desc* "]:value:{_logseq_multi_values " vals-str "}'")]
[(str "'" long-opt "=[" desc* "]:value:{_logseq_multi_values " vals-str "}'")]))
:dynamic
(let [action (case complete
@@ -223,34 +225,30 @@ _logseq_multi_values() {
:pages "_logseq_pages"
:queries "_logseq_queries")]
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:value:" action "'")
(str "'" long-opt "=[" desc* "]:value:" action "'")))
[(str "'" excl long-opt "=[" desc* "]:value:" action "'")
(str "'" excl alias-short "[" desc* "]:value:" action "'")]
[(str "'" long-opt "=[" desc* "]:value:" action "'")]))
:file
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:file:_files'")
(str "'" long-opt "=[" desc* "]:file:_files'"))
[(str "'" excl long-opt "=[" desc* "]:file:_files'")
(str "'" excl alias-short "[" desc* "]:file:_files'")]
[(str "'" long-opt "=[" desc* "]:file:_files'")])
:dir
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:dir:_files -/'")
(str "'" long-opt "=[" desc* "]:dir:_files -/'"))
[(str "'" excl long-opt "=[" desc* "]:dir:_files -/'")
(str "'" excl alias-short "[" desc* "]:dir:_files -/'")]
[(str "'" long-opt "=[" desc* "]:dir:_files -/'")])
:free
(if alias
(str "'" (str "(" alias-short " " long-opt ")") "'"
"{" alias-short "," long-opt "}"
"'=[" desc* "]:value:'")
(str "'" long-opt "=[" desc* "]:value:'"))
[(str "'" excl long-opt "=[" desc* "]:value:'")
(str "'" excl alias-short "[" desc* "]:value:'")]
[(str "'" long-opt "=[" desc* "]:value:'")])
;; default
(str "'" long-opt "=[" desc* "]:value:'"))))
[(str "'" long-opt "=[" desc* "]:value:'")])))
(defn- zsh-no-token-for
"Generate a zsh _arguments token for the --no-<option> negation of a flag.
@@ -274,7 +272,7 @@ _logseq_multi_values() {
(not (contains? global-keys (:key %))))
(:key %)))
set)]
(into (mapv #(zsh-token-for % no-prefix-keys) tokens)
(into (vec (mapcat #(zsh-token-for % no-prefix-keys) tokens))
(keep #(zsh-no-token-for % no-prefix-keys) tokens))))
(defn- zsh-leaf-function

17
src/test/logseq/cli/completion_generator_test.cljs
View File

@@ -214,12 +214,15 @@
(testing "global boolean flags do NOT emit --no- negation token"
(is (not (string/includes? output "--no-verbose")))
(is (not (string/includes? output "--no-help"))))
(testing "enum options emit value list form"
(is (string/includes? output "'{-o,--output}'=[Output format. Default: human]:value:(human json edn)'")))
(testing ":complete :graphs emits _logseq_graphs"
(is (string/includes? output "'{-g,--graph}'=[Graph name]:value:_logseq_graphs'")))
(testing ":complete :file emits _files"
(is (string/includes? output "'{-c,--config}'=[Path to cli.edn (default ~/logseq/cli.edn)]:file:_files'")))
(testing "enum options emit separate long= and short+ specs"
(is (string/includes? output "--output=[Output format. Default: human]:value:(human json edn)'"))
(is (string/includes? output "-o[Output format. Default: human]:value:(human json edn)'")))
(testing ":complete :graphs emits separate long= and short+ specs"
(is (string/includes? output "--graph=[Graph name]:value:_logseq_graphs'"))
(is (string/includes? output "-g[Graph name]:value:_logseq_graphs'")))
(testing ":complete :file emits separate long= and short+ specs"
(is (string/includes? output "--config=[Path to cli.edn (default ~/logseq/cli.edn)]:file:_files'"))
(is (string/includes? output "-c[Path to cli.edn (default ~/logseq/cli.edn)]:file:_files'")))
(testing ":alias emits grouping without --no- for global flags"
(is (re-find #"\(-h --help\)" output)))))
@@ -251,7 +254,7 @@
(testing "zsh preamble contains _logseq_multi_values helper"
(is (string/includes? output "_logseq_multi_values()")))
(testing "--fields under list tag uses {_logseq_multi_values ...} action"
(is (re-find #"--fields\}.*\{_logseq_multi_values " output)))
(is (re-find #"--fields=.*\{_logseq_multi_values " output)))
(testing "multi-values include known tag field names"
(is (string/includes? output "created-at"))
(is (string/includes? output "title"))