import {CLISHRunCommand} from 'projext-plugin-runner/src/services/cli/cliSHRun.js'

public class | source

CLISHRunCommand

CLICommand → CLISHRunCommand

This is private command the shell script executes in order to get a list of commands to run.

Constructor Summary

Public Constructor
public	constructor(runner: Runner) Class constructor.

Public Members
public	command: string The instruction needed to trigger the command.
public	description: string A description of the command, just to follow the interface as the command won't show up on the help interface.
public	hidden: boolean Hide the command from the help interface.
public	runner: Runner A local reference for the `runner` service.

Public Methods
public	handle(target: string, command: Command, options: Object) Handle the execution of the command and outputs the list of commands to run.

From class CLICommand
public	allowUnknownOptions: Boolean Whether or not the command supports unknown options.
public	checkOptionsOnParent: boolean This is a useful flag for when the command is ran as a result of another command.
public	cliName: string This is the name of the program that runs the command.
public	command: string The CLI command instruction.
public	description: string A description of the command for the help interface.
public	fullDescription: string A more complete description of the command to show when the command help interface is invoked.
public	hidden: boolean Whether the command and its description should be shown on the CLI interface list of commands.
public	options: Array A list with the name of the options the command supports.
public	optionsByName: Object A dictionary of command options settings by their option name.
public	subProgram: boolean Whether or not a sub program should be executed for this command.
private	_unknownOptions: Object This dictionary will be completed when the command gets activated.
public	addOption(name: string, instruction: string, description: string, defaultValue: string) Add a new option for the command.
public	generate(args: Object): string Generate an instruction for this command.
public abstract	handle() Handle the command execution.
public	output(text: string) A simple wrapper for a `console.log`.
public	register(program: Command, cli: Object) Register this command on a CLI program.

Class constructor.

Name	Type	Attribute	Description
runner	Runner		The service tha provides the commands to run.

The instruction needed to trigger the command.

A description of the command, just to follow the interface as the command won't show up on the help interface.

Hide the command from the help interface.

A local reference for the runner service.

Handle the execution of the command and outputs the list of commands to run.

Name	Type	Attribute	Description
target	string	nullable: true	The name of the target to run.
command	Command		The executed command (sent by `commander`).
options	Object		The command options.
options.production	string		If the user wants to run a production build, even with projext preset.
options.ready	boolean		If the user used the `production` option, then the list of commands will be: one to build the target for production and one to run this command again, because if a build is going to happen, there's no way to be sure the runner file is up to date. This option basically says 'The production build is ready and the runner file is updated, now is ok to execute it'.
options.inspect	boolean		Whether or not to enable the Node inspector.