import {CLISHInspectCommand} from 'projext/src/services/cli/cliSHInspect.js'

public class | source

CLISHInspectCommand

CLICommand → CLISHInspectCommand

This is the 'real inspect command'. This is a private command the shell script executes in order to get a list of commands it should execute.

Constructor Summary

Public Constructor
public	constructor(cliBuildCommand: CLIBuildCommand, targets: Targets) Class constructor.

Public Members
public	allowUnknownOptions: boolean Enable unknown options so other services can customize the run command.
public	cliBuildCommand: CLIBuildCommand A local reference for the `cliBuildCommand` service.
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	targets: Targets A local reference for the `targets` service.

Public Methods
public	handle(name: string, command: Command, options: Object, unknownOptions: 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
cliBuildCommand	CLIBuildCommand		The inspect command is actually an alias for the build command with the `--run` and `--inspect` flags set to true.
targets	Targets		To get the name of the default target if no other is specified.

Enable unknown options so other services can customize the run command.

A local reference for the cliBuildCommand service.

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 targets service.

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

Name	Type	Attribute	Description
name	string	nullable: true	The name of the target.
command	Command		The executed command (sent by `commander`).
options	Object		The command options.
unknownOptions	Object		A dictionary of extra options that command may have received.