2024 年 Clojure 状态调查中分享您的想法!

欢迎!请查看关于页面,了解更多此站点的信息。

+11
工具

尽管文档提到了 help/dochelp/dir,但对于用户来说,除非仔细阅读整个文档页面,否则很难知道如何获取工具的帮助。

如果 -Ttools 函数更加详细且提供帮助信息,这将帮助用户了解如何使用工具。

我认为在这方面难以做任何事情

$ clojure -Ttools
No function found on command line or in :exec-fn

但是添加一个 help 函数就意味着用户接下来可能会尝试的事情有可能会成功

$ clojure -Ttools help
Namespace clojure.tools.tools.api loaded but function not found: help

告诉用户,以下内容可用于获取可用函数列表或获取更详细的帮助,这将指导他们使用下一个函数

$ clojure -A:deps -Ttools help/dir
install
list
remove
show
$ clojure -A:deps -Ttools help/doc
...

此外,list 函数可以建议如何获取特定已安装工具的帮助

$ clojure -Ttools list
TOOL     LIB                              TYPE  VERSION
clj-new  com.github.seancorfield/clj-new  :git  v1.2.362
new      io.github.seancorfield/deps-new  :git  v0.4.0
nvd      io.github.rm-hull/nvd-clojure    :git  4b0c448
poly     io.github.polyfy/polylith        :git  768642a
tools    io.github.clojure/tools.tools    :git  v0.2.1
# add the following (arbitrarily picking the first one, perhaps):
For help with a specific tool, e.g., clj-new:
    clojure -A:deps -Tclj-new help/doc

同样,可以将此添加到 show 函数中。

1 条回答

0

被选中
...