[12.x] Adds an option to install a custom starter kits (#407)

* Adds an option to install a cuustom starter kit

With these changes, we may allow installing custom instarter kits by
passing the --starter-kit option.

For instance, "--starter-kit=hotwired-laravel/turbo-starter-kit"

* Fix option

* Reuse the hasStarterKit method and add a new one for checking for Laravel owned starter kits

* updating the name to be optional

* formatting

---------

Co-authored-by: Tony Lea <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 3 people

src/NewCommand.php

@@ -56,6 +56,7 @@ protected function configure()
             ->addOption('pest', null, InputOption::VALUE_NONE, 'Install the Pest testing framework')
             ->addOption('phpunit', null, InputOption::VALUE_NONE, 'Install the PHPUnit testing framework')
             ->addOption('npm', null, InputOption::VALUE_NONE, 'Install and build NPM dependencies')
+            ->addOption('using', null, InputOption::VALUE_OPTIONAL, 'Install a custom starter kit from a community maintained package')
             ->addOption('force', 'f', InputOption::VALUE_NONE, 'Forces install even if the directory already exists');
     }
 
@@ -108,7 +109,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
             );
         }
 
-        if (! $input->getOption('react') && ! $input->getOption('vue') && ! $input->getOption('livewire')) {
+        if (! $this->usingStarterKit($input)) {
             match (select(
                 label: 'Which starter kit would you like to install?',
                 options: [
@@ -125,7 +126,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
                 default => null,
             };
 
-            if ($this->usingStarterKit($input)) {
+            if ($this->usingLaravelStarterKit($input)) {
                 match (select(
                     label: 'Which authentication provider do you prefer?',
                     options: [
@@ -148,7 +149,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
             }
         }
 
-        if ($this->usingStarterKit($input)) {
+        if ($this->usingLaravelStarterKit($input)) {
             if (! $input->getOption('phpunit') &&
                 ! $input->getOption('pest')) {
                 $input->setOption('pest', select(
@@ -226,22 +227,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $createProjectCommand = $composer." create-project laravel/laravel \"$directory\" $version --remove-vcs --prefer-dist --no-scripts";
 
-        $stackSlug = match (true) {
-            $input->getOption('react') => 'react',
-            $input->getOption('vue') => 'vue',
-            $input->getOption('livewire') => 'livewire',
-            default => null
-        };
+        $starterKit = $this->getStarterKit($input);
 
-        if ($stackSlug) {
-            $createProjectCommand = $composer." create-project laravel/$stackSlug-starter-kit \"$directory\" --stability=dev";
+        if ($starterKit) {
+            $createProjectCommand = $composer." create-project {$starterKit} \"{$directory}\" --stability=dev";
 
-            if ($input->getOption('livewire-class-components')) {
-                $createProjectCommand = str_replace(" laravel/{$stackSlug}-starter-kit ", " laravel/{$stackSlug}-starter-kit:dev-components ", $createProjectCommand);
+            if ($this->usingLaravelStarterKit($input) && $input->getOption('livewire-class-components')) {
+                $createProjectCommand = str_replace(" {$starterKit} ", " {$starterKit}:dev-components ", $createProjectCommand);
             }
 
-            if ($input->getOption('workos')) {
-                $createProjectCommand = str_replace(" laravel/{$stackSlug}-starter-kit ", " laravel/{$stackSlug}-starter-kit:dev-workos ", $createProjectCommand);
+            if ($this->usingLaravelStarterKit($input) && $input->getOption('workos')) {
+                $createProjectCommand = str_replace(" {$starterKit} ", " {$starterKit}:dev-workos ", $createProjectCommand);
             }
         }
 
@@ -591,7 +587,7 @@ protected function installPest(string $directory, InputInterface $input, OutputI
             $this->phpBinary().' ./vendor/bin/pest --init',
         ];
 
-        if ($input->getOption('react') || $input->getOption('vue') || $input->getOption('livewire')) {
+        if ($this->usingStarterKit($input)) {
             $commands[] = $composerBinary.' require pestphp/pest-plugin-drift --dev';
             $commands[] = $this->phpBinary().' ./vendor/bin/pest --drift';
             $commands[] = $composerBinary.' remove pestphp/pest-plugin-drift --dev';
@@ -611,15 +607,15 @@ protected function installPest(string $directory, InputInterface $input, OutputI
             $directory.'/tests/Unit/ExampleTest.php',
         );
 
-        if ($input->getOption('react') || $input->getOption('vue') || $input->getOption('livewire')) {
+        if ($this->usingStarterKit($input)) {
             $this->replaceInFile(
                 './vendor/bin/phpunit',
                 './vendor/bin/pest',
                 $directory.'/.github/workflows/tests.yml',
             );
         }
 
-        if (($input->getOption('react') || $input->getOption('vue') || $input->getOption('livewire')) && $input->getOption('phpunit')) {
+        if ($this->usingStarterKit($input) && $input->getOption('phpunit')) {
             $this->deleteFile($directory.'/tests/Pest.php');
         }
 
@@ -747,6 +743,28 @@ protected function generateAppUrl($name)
         return $this->canResolveHostname($hostname) ? 'http://'.$hostname : 'http://localhost';
     }
 
+    /**
+     * Get the starter kit repository, if any.
+     */
+    protected function getStarterKit(InputInterface $input): ?string
+    {
+        return match (true) {
+            $input->getOption('react') => 'laravel/react-starter-kit',
+            $input->getOption('vue') => 'laravel/vue-starter-kit',
+            $input->getOption('livewire') => 'laravel/livewire-starter-kit',
+            default => $input->getOption('using'),
+        };
+    }
+
+    /**
+     * Determine if a Laravel first-party starter kit has been chosen.
+     */
+    protected function usingLaravelStarterKit(InputInterface $input): bool
+    {
+        return $this->usingStarterKit($input) &&
+               str_starts_with($this->getStarterKit($input), 'laravel/');
+    }
+
     /**
      * Determine if a starter kit is being used.
      *
@@ -755,7 +773,7 @@ protected function generateAppUrl($name)
      */
     protected function usingStarterKit(InputInterface $input)
     {
-        return $input->getOption('react') || $input->getOption('vue') || $input->getOption('livewire');
+        return $input->getOption('react') || $input->getOption('vue') || $input->getOption('livewire') || $input->getOption('using');
     }
 
     /**