import {CLISHValidateCommand} from 'projext-plugin-runner/src/services/cli/cliSHValidate.js'

public class | source

CLISHValidateCommand

Extends:

CLICommand → CLISHValidateCommand

This is a private command the shell script executes before running the run command in order to validate the arguments and throw any necessary error. The reason we do this in two separated commands is that the shell script takes all the output of the run command and tries to execute it, so we can't include execptions in there.

Constructor Summary

Public Constructor
public	constructor(runnerFile: RunnerFile, targets: Targets, projextPlugin: ProjextPlugin) Class constructor.

Member Summary

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	projextPlugin: ProjextPlugin A local reference for the `projextPlugin` service.
public	runnerFile: RunnerFile A local reference for the `runnerFile` service.
public	targets: Targets A local reference for the `targets` service.

Method Summary

Public Methods
public	handle(target: string): * Handle the execution of the command and validate all the arguments.

Inherited Summary

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.

Public Constructors

public constructor(runnerFile: RunnerFile, targets: Targets, projextPlugin: ProjextPlugin) source

Class constructor.

Override:

CLICommand#constructor

Params:

Name	Type	Attribute	Description
runnerFile	RunnerFile		To validate if the file exists or not.
targets	Targets		To validate if a target exists or not.
projextPlugin	ProjextPlugin		To check if projext is present or not.

Public Members

public command: string source

The instruction needed to trigger the command.

Override:

CLICommand#command

public description: string source

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

Override:

CLICommand#description

public hidden: Boolean source

Hide the command from the help interface.

Override:

CLICommand#hidden

public projextPlugin: ProjextPlugin source

A local reference for the projextPlugin service.

public runnerFile: RunnerFile source

A local reference for the runnerFile service.

public targets: Targets source

A local reference for the targets service.

Public Methods

public handle(target: string): * source

Handle the execution of the command and validate all the arguments.

Override:

CLICommand#handle

Params:

Name	Type	Attribute	Description
target	string	nullable: true	The name of the target.

CLISHValidateCommand

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(runnerFile: RunnerFile, targets: Targets, projextPlugin: ProjextPlugin) source

Override:

Params:

Public Members

public command: string source

Override:

public description: string source

Override:

public hidden: Boolean source

Override:

public projextPlugin: ProjextPlugin source

public runnerFile: RunnerFile source

public targets: Targets source

Public Methods

public handle(target: string): * source

Override:

Params:

Return: