[5.x] Add new starter-kit:init command (#11215)

statamic · Dec 5, 2024 · 2feec79 · 2feec79
1 parent 9962a63
commit 2feec79
Show file tree

Hide file tree

Showing 8 changed files with 1,062 additions and 56 deletions.
diff --git a/src/Console/Commands/Concerns/MigratesLegacyStarterKitConfig.php b/src/Console/Commands/Concerns/MigratesLegacyStarterKitConfig.php
@@ -0,0 +1,67 @@
+<?php
+
+namespace Statamic\Console\Commands\Concerns;
+
+use Statamic\Facades\File;
+
+use function Laravel\Prompts\confirm;
+
+trait MigratesLegacyStarterKitConfig
+{
+    protected $migrated = false;
+
+    /**
+     * Determine if dev sandbox has starter-kit.yaml at root and/or customized composer.json at target path.
+     */
+    protected function isUsingLegacyExporterConventions(): bool
+    {
+        return File::exists(base_path('starter-kit.yaml'));
+    }
+
+    /**
+     * Determine if dev sandbox has starter-kit.yaml at root and/or customized composer.json at target path.
+     */
+    protected function migrateLegacyConfig(?string $exportPath = null): self
+    {
+        if (! $this->isUsingLegacyExporterConventions()) {
+            return $this;
+        }
+
+        if ($this->input->isInteractive()) {
+            if (! confirm('Config should now live in the [package] folder. Would you like Statamic to move it for you?', true)) {
+                return $this;
+            }
+        }
+
+        if (! File::exists($dir = base_path('package'))) {
+            File::makeDirectory($dir, 0755, true);
+        }
+
+        if (File::exists($starterKitConfig = base_path('starter-kit.yaml'))) {
+            File::move($starterKitConfig, base_path('package/starter-kit.yaml'));
+            $this->components->info('Starter kit config moved to [package/starter-kit.yaml].');
+        }
+
+        if (File::exists($postInstallHook = base_path('StarterKitPostInstall.php'))) {
+            File::move($postInstallHook, base_path('package/StarterKitPostInstall.php'));
+            $this->components->info('Starter kit post-install hook moved to [package/StarterKitPostInstall.php].');
+        }
+
+        if ($exportPath && File::exists($packageComposerJson = $exportPath.'/composer.json')) {
+            File::move($packageComposerJson, base_path('package/composer.json'));
+            $this->components->info('Composer package config moved to [package/composer.json].');
+        }
+
+        $this->migrated = true;
+
+        return $this;
+    }
+
+    /**
+     * Check if migration logic was ran.
+     */
+    protected function migratedLegacyConfig(): bool
+    {
+        return $this->migrated;
+    }
+}
diff --git a/src/Console/Commands/StarterKitExport.php b/src/Console/Commands/StarterKitExport.php
@@ -3,6 +3,7 @@
 namespace Statamic\Console\Commands;
 
 use Illuminate\Console\Command;
+use Statamic\Console\Commands\Concerns\MigratesLegacyStarterKitConfig;
 use Statamic\Console\RunsInPlease;
 use Statamic\Facades\File;
 use Statamic\Facades\Path;
@@ -13,7 +14,7 @@
 
 class StarterKitExport extends Command
 {
-    use RunsInPlease;
+    use MigratesLegacyStarterKitConfig, RunsInPlease;
 
     /**
      * The name and signature of the console command.
@@ -36,11 +37,11 @@ class StarterKitExport extends Command
      */
     public function handle()
     {
-        if ($this->isUsingLegacyExporterConventions()) {
-            $this->askToMigrateToPackageFolder();
-        }
+        $path = $this->getAbsolutePath();
+
+        $this->migrateLegacyConfig($path);
 
-        if (! File::exists($path = $this->getAbsolutePath())) {
+        if (! File::exists($path)) {
             $this->askToCreateExportPath($path);
         }
 
@@ -55,7 +56,11 @@ public function handle()
             return 1;
         }
 
-        $this->components->info("Starter kit was successfully exported to [$path].");
+        if (version_compare(app()->version(), '11', '<')) {
+            return $this->components->info("Starter kit was successfully exported to [$path].");
+        }
+
+        $this->components->success("Starter kit was successfully exported to [$path].");
     }
 
     /**
@@ -85,43 +90,4 @@ protected function askToCreateExportPath(string $path): void
 
         $this->components->info("A new directory has been created at [{$path}].");
     }
-
-    /**
-     * Determine if dev sandbox has starter-kit.yaml at root and/or customized composer.json at target path.
-     */
-    protected function isUsingLegacyExporterConventions(): bool
-    {
-        return File::exists(base_path('starter-kit.yaml'));
-    }
-
-    /**
-     * Determine if dev sandbox has starter-kit.yaml at root and/or customized composer.json at target path.
-     */
-    protected function askToMigrateToPackageFolder(): void
-    {
-        if ($this->input->isInteractive()) {
-            if (! confirm('Config should now live in the [package] folder. Would you like Statamic to move it for you?', true)) {
-                return;
-            }
-        }
-
-        if (! File::exists($dir = base_path('package'))) {
-            File::makeDirectory($dir, 0755, true);
-        }
-
-        if (File::exists($starterKitConfig = base_path('starter-kit.yaml'))) {
-            File::move($starterKitConfig, base_path('package/starter-kit.yaml'));
-            $this->components->info('Starter kit config moved to [package/starter-kit.yaml].');
-        }
-
-        if (File::exists($postInstallHook = base_path('StarterKitPostInstall.php'))) {
-            File::move($postInstallHook, base_path('package/StarterKitPostInstall.php'));
-            $this->components->info('Starter kit post-install hook moved to [package/StarterKitPostInstall.php].');
-        }
-
-        if (File::exists($packageComposerJson = $this->getAbsolutePath().'/composer.json')) {
-            File::move($packageComposerJson, base_path('package/composer.json'));
-            $this->components->info('Composer package config moved to [package/composer.json].');
-        }
-    }
 }