API Documentation

BuildSiteCommand extends Command
in package

Run the static site build process.

Table of Contents

Constants

USER_EXIT  = 130

Properties

$description  : string
$service  : BuildService
$signature  : string
$taskService  : BuildTaskService

Methods

askForString()  : string|null
fileLink()  : string
Create a filepath that can be opened in the browser from a terminal.
gray()  : void
Write a grey-coloured line
handle()  : int
The base handle method that can be overridden by child classes.
handleException()  : int
Handle an exception that occurred during command execution.
indentedLine()  : void
Write a line with the specified indentation level
infoComment()  : void
Write a nicely formatted and consistent message to the console. Using InfoComment for a lack of a better term.
runPostBuildActions()  : void
configureBuildTaskService()  : void
getExitCode()  : int
hasWarnings()  : bool
printFinishMessage()  : void
runNodeCommand()  : void
runPreBuildActions()  : void
safeHandle()  : int
This method can be overridden by child classes to provide automatic exception handling.

Constants

USER_EXIT

public final mixed USER_EXIT = 130

Properties

$signature

protected string $signature = 'build {--run-dev : Run the NPM dev script after build} {--run-prod : Run the NPM prod script after build} {--run-prettier : Format the output using NPM Prettier} {--pretty-urls : Should links in output use pretty URLs?} {--no-api : Disable API calls, for example, Torchlight}'

Methods

askForString()

public askForString(string $question[, string|null $default = null ]) : string|null
Parameters
$question : string
$default : string|null = null
Return values
string|null

fileLink()

Create a filepath that can be opened in the browser from a terminal.

public static fileLink(string $path[, string|null $label = null ]) : string
Parameters
$path : string
$label : string|null = null

If provided, the link will be wrapped in a Symfony Console href tag. Note that not all terminals support this, and it may lead to only the label being shown, and the path being lost to the void.

Return values
string

gray()

Write a grey-coloured line

public gray(string $string) : void
Parameters
$string : string

handle()

The base handle method that can be overridden by child classes.

public handle() : int

Alternatively, implement the safeHandle method in your child class to utilize the automatic exception handling provided by this method.

Return values
int —

The exit code.

handleException()

Handle an exception that occurred during command execution.

public handleException(Exception $exception) : int
Parameters
$exception : Exception
Return values
int —

The exit code

indentedLine()

Write a line with the specified indentation level

public indentedLine(int $spaces, string $string) : void
Parameters
$spaces : int
$string : string

infoComment()

Write a nicely formatted and consistent message to the console. Using InfoComment for a lack of a better term.

public infoComment(string $string) : void

Text in [brackets] will automatically be wrapped in tags.

Parameters
$string : string

configureBuildTaskService()

protected configureBuildTaskService() : void

printFinishMessage()

protected printFinishMessage(float $timeStart) : void
Parameters
$timeStart : float

runNodeCommand()

protected runNodeCommand(string $command, string $message[, string|null $actionMessage = null ]) : void
Parameters
$command : string
$message : string
$actionMessage : string|null = null

safeHandle()

This method can be overridden by child classes to provide automatic exception handling.

protected safeHandle() : int

Existing code can be converted simply by renaming the handle() method to safeHandle().

Return values
int —

The exit code.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results