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

CLISHValidateBuildCommand

Extends:

CLICommand → CLISHValidateBuildCommand

This is a private command the shell script executes before running the build 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 build command and tries to execute it, so we can't include execptions in there.

Constructor Summary

Public Constructor
public

constructor(appLogger: Logger, targets: Targets, targetsHTML: TargetsHTML, tempFiles: TempFiles)

Class constructor.

Member Summary

Public Members
public

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

public

A local reference for the appLogger 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.

public

A local reference for the targetsHTML service.

public

A local reference for the tempFiles service.

Method Summary

Public Methods
public

handle(name: string, command: Command, options: CLIBuildCommandOptions)

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

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(appLogger: Logger, targets: Targets, targetsHTML: TargetsHTML, tempFiles: TempFiles) source

Class constructor.

Override:

CLICommand#constructor

Params:

NameTypeAttributeDescription
appLogger Logger

To inform the user if something goes wrong.

targets Targets

To validate a target existence.

targetsHTML TargetsHTML

To validate a browser target HTML file.

tempFiles TempFiles

To validate that the temp directory can be created.

Public Members

public allowUnknownOptions: boolean source

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

Override:

CLICommand#allowUnknownOptions

public appLogger: Logger source

A local reference for the appLogger 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 targetsHTML: TargetsHTML source

A local reference for the targetsHTML service.

public tempFiles: TempFiles source

A local reference for the tempFiles service.

Public Methods

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

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

Override:

CLICommand#handle

Params:

NameTypeAttributeDescription
name string
  • nullable: true

The name of the target.

command Command

The executed command (sent by commander).

options CLIBuildCommandOptions

The command options.

Throw:

Error

If the inspect option is used for a browser target.