balena-cli/build/actions/help.js

116 lines
3.2 KiB
JavaScript
Raw Normal View History

2015-02-26 15:47:56 +00:00
(function() {
var _, capitano, columnify, command, general, indent, parse, print;
2015-02-26 15:47:56 +00:00
_ = require('lodash');
_.str = require('underscore.string');
capitano = require('capitano');
columnify = require('columnify');
2015-02-26 15:47:56 +00:00
parse = function(object) {
return _.object(_.map(object, function(item) {
var signature;
if (item.alias != null) {
signature = item.toString();
} else {
signature = item.signature.toString();
2015-02-26 15:47:56 +00:00
}
return [signature, item.description];
}));
2015-02-26 15:47:56 +00:00
};
indent = function(text) {
text = _.map(_.str.lines(text), function(line) {
return ' ' + line;
2015-02-26 15:47:56 +00:00
});
return text.join('\n');
2015-02-26 15:47:56 +00:00
};
print = function(data) {
return console.log(indent(columnify(data, {
showHeaders: false,
minWidth: 35
})));
2015-02-26 15:47:56 +00:00
};
general = function(params, options, done) {
var commands, groupedCommands;
2015-02-26 15:47:56 +00:00
console.log('Usage: resin [COMMAND] [OPTIONS]\n');
console.log('Primary commands:\n');
commands = _.reject(capitano.state.commands, function(command) {
return command.isWildcard();
});
groupedCommands = _.groupBy(commands, function(command) {
if (command.plugin) {
return 'plugins';
} else if (command.primary) {
return 'primary';
}
return 'secondary';
});
print(parse(groupedCommands.primary));
if (options.verbose) {
if (!_.isEmpty(groupedCommands.plugins)) {
console.log('\nInstalled plugins:\n');
print(parse(groupedCommands.plugins));
}
console.log('\nAdditional commands:\n');
print(parse(groupedCommands.secondary));
} else {
console.log('\nRun `resin help --verbose` to list additional commands');
}
2015-08-12 12:17:46 +00:00
if (!_.isEmpty(capitano.state.globalOptions)) {
console.log('\nGlobal Options:\n');
print(parse(capitano.state.globalOptions));
2015-08-12 12:17:46 +00:00
}
return done();
2015-02-26 15:47:56 +00:00
};
command = function(params, options, done) {
2015-02-26 15:47:56 +00:00
return capitano.state.getMatchCommand(params.command, function(error, command) {
if (error != null) {
return done(error);
}
if ((command == null) || command.isWildcard()) {
return done(new Error("Command not found: " + params.command));
2015-02-26 15:47:56 +00:00
}
console.log("Usage: " + command.signature);
if (command.help != null) {
console.log("\n" + command.help);
} else if (command.description != null) {
console.log("\n" + (_.str.humanize(command.description)));
}
if (!_.isEmpty(command.options)) {
console.log('\nOptions:\n');
print(parse(command.options));
2015-02-26 15:47:56 +00:00
}
return done();
});
};
exports.help = {
signature: 'help [command...]',
description: 'show help',
help: 'Get detailed help for an specific command.\n\nExamples:\n\n $ resin help apps\n $ resin help os download',
primary: true,
options: [
{
signature: 'verbose',
description: 'show additional commands',
boolean: true,
alias: 'v'
}
],
2015-02-26 15:47:56 +00:00
action: function(params, options, done) {
if (params.command != null) {
return command(params, options, done);
2015-02-26 15:47:56 +00:00
} else {
return general(params, options, done);
2015-02-26 15:47:56 +00:00
}
}
};
}).call(this);