/** * @license * Copyright (c) 2016 The Polymer Project Authors. All rights reserved. * This code may only be used under the BSD style license found at * http://polymer.github.io/LICENSE.txt * The complete set of authors may be found at * http://polymer.github.io/AUTHORS.txt * The complete set of contributors may be found at * http://polymer.github.io/CONTRIBUTORS.txt * Code distributed by Google as part of the polymer project is also * subject to an additional IP rights grant found at * http://polymer.github.io/PATENTS.txt */ // Be careful with these imports. As many as possible should be dynamic imports // in the run method in order to minimize startup time from loading unused code. import chalk from 'chalk'; import * as commandLineUsage from 'command-line-usage'; import * as logging from 'plylog'; import {ProjectConfig} from 'polymer-project-config'; import {globalArguments} from '../args'; import {Command, CommandOptions} from './command'; const logger = logging.getLogger('cli.command.help'); const b = chalk.blue; const m = chalk.magenta; const CLI_TITLE = chalk.bold.underline('Polymer-CLI'); const CLI_DESCRIPTION = 'The multi-tool for Polymer projects'; const CLI_USAGE = 'Usage: \`polymer [options ...]\`'; const HELP_HEADER = ` ${b('/\\\\˜˜/')} ${m('/\\\\˜˜/')}${b('\\\\')} ${b('/__\\\\/')} ${m('/__\\\\/')}${b('__\\\\')} ${CLI_TITLE} ${b('/\\\\ /')} ${m('/\\\\ /')}${b('\\\\ /\\\\')} ${b('/__\\\\/')} ${m('/__\\\\/')} ${b('\\\\/__\\\\')} ${CLI_DESCRIPTION} ${b('\\\\ /\\\\')} ${m('/\\\\ /')} ${b('/\\\\ /')} ${b('\\\\/__\\\\')}${m('/__\\\\/')} ${b('/__\\\\/')} ${CLI_USAGE} ${b('\\\\')} ${m('/\\\\ /')} ${b('/\\\\ /')} ${b('\\\\')}${m('/__\\\\/')} ${b('/__\\\\/')} `; export class HelpCommand implements Command { name = 'help'; aliases = []; description = 'Shows this help message, or help for a specific command'; args = [{ name: 'command', description: 'The command to display help for', defaultOption: true, }]; commands: Map = new Map(); constructor(commands: Map) { this.commands = commands; } generateGeneralUsage() { return commandLineUsage([ { content: HELP_HEADER, raw: true, }, { header: 'Available Commands', content: Array.from(new Set(this.commands.values())).map((command) => { return {name: command.name, summary: command.description}; }), }, {header: 'Global Options', optionList: globalArguments}, { content: 'Run `polymer help ` for help with a specific command.', raw: true, } ]); } async generateCommandUsage(command: Command, config: ProjectConfig) { const extraUsageGroups = command.extraUsageGroups ? await command.extraUsageGroups(config) : []; const usageGroups: commandLineUsage.UsageGroup[] = [ { header: `polymer ${command.name}`, content: command.description, }, {header: 'Command Options', optionList: command.args}, {header: 'Global Options', optionList: globalArguments}, ]; if (command.aliases.length > 0) { usageGroups.splice(1, 0, {header: 'Alias(es)', content: command.aliases}); } return commandLineUsage(usageGroups.concat(extraUsageGroups)); } async run(options: CommandOptions, config: ProjectConfig) { const commandName: string = options['command']; if (!commandName) { logger.debug( 'no command given, printing general help...', {options: options}); console.log(this.generateGeneralUsage()); return; } const command = this.commands.get(commandName); if (!command) { logger.error(`'${commandName}' is not an available command.`); console.log(this.generateGeneralUsage()); return; } logger.debug(`printing help for command '${commandName}'...`); console.log(await this.generateCommandUsage(command, config)); } }