Rename docker-compose.yml to compose.yaml (#818)

* Rename `docker-compose.yml` to `compose.yaml`

* formatting

---------

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

Author: CasEbb

src/Console/Concerns/InteractsWithDockerComposeServices.php

@@ -7,6 +7,18 @@
 
 trait InteractsWithDockerComposeServices
 {
+    /**
+     * Possible names for the compose file according to the spec.
+     *
+     * @var array<string>
+     */
+    protected $composePaths = [
+        'compose.yaml',
+        'compose.yml',
+        'docker-compose.yaml',
+        'docker-compose.yml',
+    ];
+
     /**
      * The available services that may be installed.
      *
@@ -62,11 +74,11 @@ protected function gatherServicesInteractively()
      */
     protected function buildDockerCompose(array $services)
     {
-        $composePath = base_path('docker-compose.yml');
+        $composePath = $this->composePath();
 
         $compose = file_exists($composePath)
             ? Yaml::parseFile($composePath)
-            : Yaml::parse(file_get_contents(__DIR__ . '/../../../stubs/docker-compose.stub'));
+            : Yaml::parse(file_get_contents(__DIR__ . '/../../../stubs/compose.stub'));
 
         // Prepare the installation of the "mariadb-client" package if the MariaDB service is used...
         if (in_array('mariadb', $services)) {
@@ -84,7 +96,7 @@ protected function buildDockerCompose(array $services)
                 ->all();
         }
 
-        // Add the services to the docker-compose.yml...
+        // Add the services to the compose.yaml...
         collect($services)
             ->filter(function ($service) use ($compose) {
                 return ! array_key_exists($service, $compose['services'] ?? []);
@@ -111,7 +123,7 @@ protected function buildDockerCompose(array $services)
 
         $yaml = str_replace('{{PHP_VERSION}}', $this->hasOption('php') ? $this->option('php') : '8.4', $yaml);
 
-        file_put_contents($this->laravel->basePath('docker-compose.yml'), $yaml);
+        file_put_contents($composePath, $yaml);
     }
 
     /**
@@ -313,4 +325,16 @@ protected function runCommands($commands)
             $this->output->write('    '.$line);
         });
     }
+
+    /**
+     * Get the path to an existing Compose file or fall back to a default of `compose.yaml`.
+     *
+     * @return string
+     */
+    protected function composePath()
+    {
+        return collect($this->composePaths)
+            ->map(fn ($path) => $this->laravel->basePath($path))
+            ->first(fn ($path) => file_exists($path), $this->laravel->basePath('compose.yaml'));
+    }
 }

src/Console/PublishCommand.php

@@ -3,11 +3,14 @@
 namespace Laravel\Sail\Console;
 
 use Illuminate\Console\Command;
+use Laravel\Sail\Console\Concerns\InteractsWithDockerComposeServices;
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand(name: 'sail:publish')]
 class PublishCommand extends Command
 {
+    use InteractsWithDockerComposeServices;
+
     /**
      * The name and signature of the console command.
      *
@@ -33,7 +36,7 @@ public function handle()
         $this->call('vendor:publish', ['--tag' => 'sail-database']);
 
         file_put_contents(
-            $this->laravel->basePath('docker-compose.yml'),
+            $this->composePath(),
             str_replace(
                 [
                     './vendor/laravel/sail/runtimes/8.4',
@@ -53,7 +56,7 @@ public function handle()
                     './docker/mysql',
                     './docker/pgsql'
                 ],
-                file_get_contents($this->laravel->basePath('docker-compose.yml'))
+                file_get_contents($this->composePath())
             )
         );
     }

stubs/docker-compose.stub renamed to stubs/compose.stub

@@ -2,7 +2,7 @@
 {
 	"name": "Existing Docker Compose (Extend)",
 	"dockerComposeFile": [
-		"../docker-compose.yml"
+		"../compose.yaml"
 	],
 	"service": "laravel.test",
 	"workspaceFolder": "/var/www/html",