Add support for Docker based PHP Environmet

Support for Docker based PHP environment configurable with config keys:

{
    "Laravel.dockerService": "php", // from `docker compose config --services`
    "Laravel.dockerBase": "/app", // from `docker compose exec {dockerService} pwd`
}

This plugin does not auto boot Docker container(s) although it can be implemented in later revisions. For now, ensure that Docker container is running with configured dockerService name and dockerBase path as working directory before attempting to use the plugin with Docker support.

Author: shanto

package.json

@@ -232,6 +232,7 @@
                         "sail",
                         "lando",
                         "ddev",
+                        "docker",
                         "local"
                     ],
                     "enumItemLabels": [
@@ -241,6 +242,7 @@
                         "Sail",
                         "Lando",
                         "DDEV",
+                        "Docker",
                         "Local"
                     ],
                     "markdownEnumDescriptions": [
@@ -250,6 +252,7 @@
                         "Sail",
                         "Lando",
                         "DDEV",
+                        "Docker",
                         "Use PHP installed on the local machine."
                     ],
                     "default": "auto",
@@ -259,6 +262,16 @@
                     "type": "string",
                     "description": "Template for running PHP code. Use {code} as an optional placeholder for the php file to run. e.g. `php \"{code}\"`.\n\nIf no {code} is present, code filepath will be appended to the command."
                 },
+                "Laravel.dockerService": {
+                    "type": "string",
+                    "default": "php",
+                    "description": "Name of the Docker service container holding PHP executable and Laravel app source code."
+                },
+                "Laravel.dockerBase": {
+                    "type": "string",
+                    "default": "/app",
+                    "description": "Base path of the Laravel app source code inside Docker container."
+                },
                 "Laravel.basePath": {
                     "type": "string",
                     "default": "",
@@ -674,4 +687,4 @@
         "vscode-languageserver-textdocument": "^1.0.11",
         "vscode-languageserver-types": "^3.17.5"
     }
-}
+}

src/support/config.ts

@@ -6,6 +6,8 @@ type ConfigKey =
     | "basePath"
     | "phpEnvironment"
     | "phpCommand"
+    | "dockerService"
+    | "dockerBase"
     | "tests.docker.enabled"
     | "tests.ssh.enabled"
     | "tests.suiteSuffix"

src/support/php.ts

@@ -1,6 +1,7 @@
 import { getTemplate, TemplateName } from "@src/templates";
 import * as cp from "child_process";
 import * as fs from "fs";
+import { sep as pathsep } from "path";
 import * as vscode from "vscode";
 import { BoundedFileCache } from "./cache";
 import { config } from "./config";
@@ -110,6 +111,15 @@ const getPhpCommand = (): string => {
             let check = checks.shift();
             let result = "";
 
+            if (phpEnv === "docker") {
+                const dockerService = config<string>("dockerService", "php");
+                check = check?.replace("{dockerService}", dockerService);
+                option.command = option.command.replace(
+                    "{dockerService}",
+                    dockerService,
+                );
+            }
+
             while (check) {
                 info(`Checking ${key} PHP installation: ${check}`);
 
@@ -251,7 +261,7 @@ export const runInLaravel = <T>(
 
 export const fixFilePath = (path: string) => {
     if (phpEnvironmentsThatUseRelativePaths.includes(phpEnvKey!)) {
-        return relativePath(path);
+        return relativePath(path).replaceAll(pathsep, "/");
     }
 
     return path;

src/support/phpEnvironments.ts

@@ -14,6 +14,7 @@ export type PhpEnvironment =
     | "sail"
     | "lando"
     | "ddev"
+    | "docker"
     | "local";
 
 export const phpEnvironments: Record<PhpEnvironment, PhpEnvironmentConfig> = {
@@ -52,6 +53,12 @@ export const phpEnvironments: Record<PhpEnvironment, PhpEnvironmentConfig> = {
         command: "ddev php",
         relativePath: true,
     },
+    docker: {
+        label: "Docker",
+        check: "docker compose exec {dockerService} which php",
+        command: 'docker compose exec {dockerService} "{binaryPath}"',
+        relativePath: true,
+    },
     local: {
         label: "Local",
         description: "Use PHP installed on the local machine.",

src/support/project.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import * as path from "path";
 import * as vscode from "vscode";
 import { config } from "./config";
-import { isPhpEnv } from "./php";
+import { getPhpEnv, isPhpEnv } from "./php";
 
 let internalVendorExists: boolean | null = null;
 
@@ -35,6 +35,14 @@ export const pathForPhpEnv = (srcPath: string): string => {
         return srcPath.replace(new RegExp("^/var/www/html/"), "");
     }
 
+    if (srcPath.match(/^\//) && getPhpEnv() === "docker") {
+        const dockerBase = config<string>("dockerBase", "/app").replace(
+            /\/$/,
+            "",
+        );
+        return projectPath(srcPath.replace(new RegExp(`^${dockerBase}/?`), ""));
+    }
+
     return srcPath;
 };