AssetCompile
abstract class System\Console\Asset\AssetCompile
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterface
Extends
Class | Description |
---|---|
Command
|
Command base class Contains utilities to make developing CLI commands nicer |
Traits
Trait | Description |
---|---|
HandlesCleanup
|
Console Command Trait that injects cross-platform signal handling to trigger cleanup on exit through the handleCleanup() method on the implementing class. |
ProvidesAutocompletion
|
Console Command Trait that injects cross-platform signal handling to trigger cleanup on exit through the handleCleanup() method on the implementing class. |
Properties
protected $configFile : string
Name of config file i.e. mix.webpack.js, vite.config.js
protected
$description
:
string
= "Mix and compile assets"
The console command description.
protected $packageJson : System\Classes\Asset\PackageJson
PackageJson object holding the contents of the active package.json
protected $watchingFilePath : string
File path being watched, used for cleanup by mix:watch
inherited protected $laravel : Winter\Storm\Foundation\Application
inherited
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
Methods
public compileHandle (string $type) : integer
Property | Type | Description |
---|---|---|
$type | string |
string
|
public watchHandle (string $type) : integer
Property | Type | Description |
---|---|---|
$type | string |
string
|
protected afterExecution (string $configPath) : void
Ran after dispatching the compile process, use for tearing down
Property | Type | Description |
---|---|---|
$configPath | string |
string
|
protected beforeExecution (string $configPath) : void
Ran before dispatching the compile process, use for setting up
Property | Type | Description |
---|---|---|
$configPath | string |
string
|
protected createCommand (string $configPath) : array
Create the command array to create a Process object with
Property | Type | Description |
---|---|---|
$configPath | string |
string
|
protected executeProcess (string $configPath) : integer
Run the mix command against the provided package
Property | Type | Description |
---|---|---|
$configPath | string |
string
|
protected getJsConfigPath (string $path) : string
Get the path to the mix.webpack.js file for the provided winter.mix.js file
Property | Type | Description |
---|---|---|
$path | string |
string
|
protected getNpmPackageManifest () : System\Classes\Asset\PackageJson
Read the package.json file for the project, path configurable with the
--manifest
option
protected getPackagePath (string $path) : string
Get the package path for the provided winter.mix.js file
Property | Type | Description |
---|---|---|
$path | string |
string
|
protected isPackageWithinWorkspace (string $mixJsPath) : bool
Check if Mix is able to compile the provided winter.mix.js file
Property | Type | Description |
---|---|---|
$mixJsPath | string |
string
|
inherited public __construct ()
Create a new command instance.
inherited
public
alert (string $string, int | string | null $verbosity = null
)
: void
Write a string in an alert box.
Property | Type | Description |
---|---|---|
$string | string |
string
|
$verbosity | int | string | null |
int | string | null
|
inherited public complete (Symfony\Component\Console\Completion\CompletionInput $input, Symfony\Component\Console\Completion\CompletionSuggestions $suggestions) : void
Provide autocompletion for this command's input
Property | Type | Description |
---|---|---|
$input | Symfony\Component\Console\Completion\CompletionInput |
Symfony\Component\Console\Completion\CompletionInput
|
$suggestions | Symfony\Component\Console\Completion\CompletionSuggestions |
Symfony\Component\Console\Completion\CompletionSuggestions
|
inherited
public
error (string $string, int | string | null $verbosity = null
)
: void
Write a string as error output.
Property | Type | Description |
---|---|---|
$string | string |
string
|
$verbosity | int | string | null |
int | string | null
|
inherited public getSubscribedSignals () : array
Returns the process signals this command listens to
inherited public handleSignal (integer $signal) : void
Handle the provided Unix process signal
Property | Type | Description |
---|---|---|
$signal | integer |
integer
|
inherited public handleWindowsSignal (integer $event) : void
Handle the provided Windows process singal.
Property | Type | Description |
---|---|---|
$event | integer |
integer
|
Extended by
Class | Description |
---|---|
MixCompile
|
|
ViteCompile
|