console/commands/ListCommand.js

//--------------------------------------------------------
//-- Node IoC - Console - Command - List
//--------------------------------------------------------

import Command from '../Command';


/**
 * Command that displays a list of the available commands.
 *
 * @memberof console.commands
 * @augments console.Command
 * @hideconstructor
 */
class ListCommand extends Command {

	/**
	 * @inheritdoc
	 */
	get name() {
		return 'list';
	}

	/**
	 * @inheritdoc
	 */
	get description() {
		return this.t('commands.list.description');
	}

	/**
	 * @inheritdoc
	 */
	async handle() {
		await this.captureOutput().call('--help', false);

		this.printPrettifiedYargsHelp(this.getCapturedOutput());
	}

	/**
	 * Print prettified text based on the default Yargs --help output.
	 *
	 * @param {string} help - The help text printed by Yargs.
	 */
	printPrettifiedYargsHelp(help) {
		const lines = help.split(`\n`);

		// This line is hard coded by Yargs, so we can assume it will always be printed.
		// We add 2 here to skip the 'Commands' string and the first command, which is always
		// the default one, without any signature.
		const index = lines.findIndex((line) => {
			return (/^\s*Commands:$/u).test(line);
		}) + 2;

		// The space after the commands is also hard coded by Yargs.
		const lastIndex = lines.slice(index).findIndex((line) => {
			return (/^\s*$/u).test(line);
		}, index) + index;

		const optionLines = lines.slice(lastIndex + 1).map((line) => {
			return line.replace(/ +\[\w+\]$/u, '');
		});


		const groups = this.getCommandGroups();


		this.terminal.spacer();
		this.terminal.echo(this.app.make('config').get('app.name', 'Node IoC'));
		this.terminal.spacer();
		this.terminal.echo(`${this.t('commands.list.messages.usage')}:`);
		this.terminal.print(`${this.t('commands.list.messages.usage-example')}`);
		this.terminal.spacer();
		this.terminal.echo(`${this.t('commands.list.messages.available-commands')}:`);

		Object.keys(groups).sort().forEach((group) => {
			if (group) {
				this.terminal.print(group);
			}
			groups[group].forEach((item) => {
				if (item.trim().length > 0) {
					this.terminal.echo(`   ${item.trim()}`);
				}
			});
		});

		this.terminal.spacer();

		optionLines.forEach((line) => {
			this.terminal.echo(line);
		});
	}

	/**
	 * Get Command groups.
	 *
	 * @returns {object<string, Array<Command>>} The commands, grouped by name.
	 */
	getCommandGroups() {
		const all = this.app.make('command').all(true, true);
		const indent = Object.values(all)
			.flat()
			.sort(({ name: a }, { name: b }) => {
				return a.length - b.length;
			})
			.pop().name.length + 2;

		const groups = {};

		Object.keys(all).forEach((group) => {
			groups[group] = all[group].map((command) => {
				const { name } = command;
				const description = this.getCommandDescription(command);

				return `${name}${' '.repeat(indent - name.length)}${description}`;
			});
		});

		return groups;
	}

	/**
	 * Get command description.
	 *
	 * @param {console.Command} command - The command instance.
	 * @returns {string} The command instance description.
	 */
	getCommandDescription(command) {
		const commandRepository = this.app.make('command');

		let rootCommand = command;
		let { name, description, forward } = rootCommand;

		while (rootCommand && forward && (!description || description === name)) {
			rootCommand = commandRepository.get(forward);
			if (rootCommand) {
				({ name, description, forward } = rootCommand);
			}
		}

		return description;
	}

}


export default ListCommand;