SBT предоставляет помощь для пользовательских команд

Question

Как вы можете помочь для пользовательских команд в sbt?

Я хочу, чтобы отобразить указанную помощь в случае арг я набор неправильны (например, положить строку в число арг)

Я также хочу, чтобы отобразить справку, если help <myCommand> набирается.

Любые подсказки? В документации ничего не говорится об этом: http://www.scala-sbt.org/0.12.4/docs/Extending/Commands.html

И google тоже не помогает.

Спасибо.

Answer 1

Согласно the documentation, help должен работать на Command с. Но вам необходимо правильно определить ваш Command, используя один из методов в Command.scala, например.

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