ViteInstall
class System\Console\Asset\Vite\ViteInstall
extends System\Console\Asset\AssetInstall
implements
Symfony\Component\Console\Command\SignalableCommandInterfaceExtends
| Class | Description |
|---|---|
AssetInstall
|
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
$assetType
:
string
= "vite"
The type of compilable to configure
protected
$configFile
:
string
= "vite.config.mjs"
The asset config file
protected
static
$defaultName
:
string
|
null
= "vite:install"
The default command name for lazy loading.
protected
$description
:
string
= "Install Node.js dependencies required for vite assets"
The console command description.
protected
$requiredPackages
:
array
= {"vite":"^5.2.11","laravel-vite-plugin":"^1.0.4"}
The required packages for this compiler
protected
$signature
:
string
= "vite:install\n {npmArgs?* : Arguments to pass through to the \"npm\" binary}\n {--npm= : Defines a custom path to the \"npm\" binary}\n {--p|package=* : Defines one or more packages to install}"
The name and signature of this command.
inherited protected $laravel : Winter\Storm\Foundation\Application
inherited
protected
$npmCommand
:
string
= "install"
The NPM command to run.
inherited
protected
$npmPath
:
string
= "npm"
The path to the "npm" executable.
inherited
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
inherited
protected
$terms
:
array
= {"complete":"install","completed":"installed"}
Terms used in messages.
Methods
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 handle () : integer
Execute the console command.
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
|
inherited protected getNpmVersion () : string
Gets the installed NPM version.
inherited protected getRequestedAndRegisteredPackages () : array
inherited protected installPackageDeps () : integer
Installs the dependencies for the given package.
inherited protected processPackages (array $registeredPackages, System\Classes\Asset\PackageJson $packageJson) : System\Classes\Asset\PackageJson
| Property | Type | Description |
|---|---|---|
| $registeredPackages | array |
array
|
| $packageJson | System\Classes\Asset\PackageJson |
System\Classes\Asset\PackageJson
|
inherited protected validateRequirePackagesPresent (System\Classes\Asset\PackageJson $packageJson) : System\Classes\Asset\PackageJson
| Property | Type | Description |
|---|---|---|
| $packageJson | System\Classes\Asset\PackageJson |
System\Classes\Asset\PackageJson
|