SBT爲自定義命令提供幫助

Question

如何爲sbt中的自定義命令提供幫助？

我想顯示的情況下，說幫我設置了ARG遊戲錯誤（比如把一個串中的ARG）

我也想，如果help <myCommand>鍵入顯示幫助。

任何線索？該文檔沒有說任何關於它： http://www.scala-sbt.org/0.12.4/docs/Extending/Commands.html

而谷歌也沒有幫助。

謝謝。

Answer 1

根據the documentation,help應工作在Command s。但是您需要使用Command.scala中的一種方法正確定義您的Command，例如，

commands += Command.command("foo", "bar", "baz")(...) 

然後

> foo<TAB> 
    bar 
> help foo 
    baz 

任何人想爲Task做同樣的，這裏有一個答案的好處...

的help輸入任務是要用戶輸入的內容，例如

> help compile 
Compiles sources. 

並提供文檔字符串，您在爲您的Task定義密鑰時提供它。例如

val compile = TaskKey[CompileAnalysis]("compile", "Compiles sources.", APlusTask) 

後來分配的關鍵Task的實施，像這樣

compile <<= compileTask 

或使用新的宏基於API（我討厭）

compile := { println("hello world") ; compile.value } 

很多

• https://github.com/sbt/sbt/blob/1.0.x/main/src/main/scala/sbt/Keys.scala
• https://github.com/sbt/sbt/blob/1.0.x/main/src/main/scala/sbt/Defaults.scala