尽管文档中提到了 help/doc
和 help/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
函数中。