指挥官的短期帮助和长期帮助



我使用命令程序包作为CLI解析器。

commander
.command('command1 <parameter>' )
.description('description 1 goes here')
.command('command2 <parameter>' )
.description('description 2 goes here')

当调用全局帮助命令时,是否有显示简短描述的方法,例如

myprogram help
# Commands:
#  command1 <parameter>  description 1 goes here
#  command2 <parameter>  description 2 goes here   

而且当调用特定命令的帮助时,也有能力显示扩展的帮助:

myprogram help command1
# command1 is used for...
#
# ... detailed description
#
# ...

通过包的作者帮助解决了这个问题。.description()可用于添加仅显示在一般help命令上的简短内联描述,而.addHelpText()可包括显示在命令特定帮助上的附加帮助测试,例如

commander
.command('hello')
.description('Shows greetings')
.addHelpText('after', 'nGreets the world ....< long text goes here >')

相关内容

  • 没有找到相关文章

最新更新