import {CLISHValidateAnalyzeCommand} from 'projext/src/services/cli/cliSHValidateAnalyze.js'
CLISHValidateAnalyzeCommand
Extends:
This is a private command the shell script executes before running the analyze 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(targets: Targets) Class constructor. |
Member Summary
Public Members | ||
public |
Enable unknown options so other services can customize the run command. |
|
public |
The instruction needed to trigger the command. |
|
public |
A description of the command, just to follow the interface as the command won't show up on the help interface. |
|
public |
Hide the command from the help interface. |
|
public |
A local reference for the |
Method Summary
Public Methods | ||
public |
Handle the execution of the command and validate the target existence. |
Inherited Summary
From class CLICommand | ||
public |
Whether or not the command supports unknown options. |
|
public |
This is a useful flag for when the command is ran as a result of another command. |
|
public |
This is the name of the program that runs the command. |
|
public |
The CLI command instruction. |
|
public |
A description of the command for the help interface. |
|
public |
A more complete description of the command to show when the command help interface is invoked. |
|
public |
Whether the command and its description should be shown on the CLI interface list of commands. |
|
public |
A list with the name of the options the command supports. |
|
public |
A dictionary of command options settings by their option name. |
|
public |
Whether or not a sub program should be executed for this command. |
|
private |
This dictionary will be completed when the command gets activated. |
|
public |
Add a new option for the command. |
|
public |
Generate an instruction for this command. |
|
public abstract |
handle() Handle the command execution. |
|
public |
A simple wrapper for a |
|
public |
Register this command on a CLI program. |
Public Constructors
public constructor(targets: Targets) source
Class constructor.
Override:
CLICommand#constructorParams:
Name | Type | Attribute | Description |
targets | Targets | To validate a target existence. |
Public Members
public allowUnknownOptions: boolean source
Enable unknown options so other services can customize the run command.
Override:
CLICommand#allowUnknownOptionspublic command: string source
The instruction needed to trigger the command.
Override:
CLICommand#commandpublic 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#descriptionPublic Methods
public handle(name: string): * source
Handle the execution of the command and validate the target existence.
Override:
CLICommand#handleParams:
Name | Type | Attribute | Description |
name | string |
|
The name of the target. |
Return:
* |
Throw:
If the target type is |