如何让Vorpal输出命令的描述

时间:2015-10-17 13:17:06

标签: javascript function this command-line-interface vorpal.js

目前我的代码如下:

var vorpal = require('vorpal')();

console.log("Are you sure you wish to investigate the murder?")

vorpal
.delimiter('grey9nr$')
.show();

vorpal.command('Yes')
.action(function(args, cb){
const self = this;
this.prompt({
type: 'confirm',
name: 'continue',
default: false,
message: 'That sounds like a really bad idea. Continue?',
}, function(result){
if (result.continue) {
self.log('Good move.');
cb();
} else {
self.log('Your life is in danger. We will contact you with more information in due course.');
app.destroyDatabase(cb);
}
});
});

结果如下:

Screenshot

我希望能够定义是什么意思,以便玩家知道回答是什么'是'会做,或要求他们做。

1 个答案:

答案 0 :(得分:3)

您可以将描述作为command()函数的第二个参数传递,也可以使用description()明确设置。

无论

vorpal.command('Yes', `These words will show up in the help')
.action(function(args, cb){
...

vorpal.command('Yes')
.description('`These words will show up in the help'')
.action(function(args, cb){
...