Home Manual Reference Source
import {CLISHInspectCommand} from 'projext/src/services/cli/cliSHInspect.js'
public class | source

CLISHInspectCommand

Extends:

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.

Member Summary

Public Members
public

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

public

A local reference for the cliBuildCommand service.

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

Method Summary

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.

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

addOption(name: string, instruction: string, description: string, defaultValue: string)

Add a new option for the command.

public

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(cliBuildCommand: CLIBuildCommand, targets: Targets) source

Class constructor.

Override:

CLICommand#constructor

Params:

NameTypeAttributeDescription
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.

Public Members

public allowUnknownOptions: boolean source

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

Override:

CLICommand#allowUnknownOptions

public cliBuildCommand: CLIBuildCommand source

A local reference for the cliBuildCommand service.

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 targets: Targets source

A local reference for the targets service.

Public Methods

public handle(name: string, command: Command, options: Object, unknownOptions: Object) source

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

Override:

CLICommand#handle

Params:

NameTypeAttributeDescription
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.