Merge pull request #184 from laravel/configure-basepath

Allow configuration of project base path

Author: joetannenbaum

package.json

@@ -100,6 +100,11 @@
                     "type": "string",
                     "description": "Template for running PHP code. Use {code} as a placeholder for the php file to run. e.g. `php \"{code}\"`"
                 },
+                "Laravel.basePath": {
+                    "type": "string",
+                    "default": "",
+                    "markdownDescription": "_Relative_ base path for the Laravel project. This is used to resolve paths in the project. e.g. src, code/backend\n\n_Requires extension reload after changing._"
+                },
                 "Laravel.showErrorPopups": {
                     "type": "boolean",
                     "default": true,

src/support/config.ts

@@ -3,6 +3,7 @@ import { GeneratedConfigKey } from "./generated-config";
 
 type ConfigKey =
     | GeneratedConfigKey
+    | "basePath"
     | "phpEnvironment"
     | "phpCommand"
     | "tests.docker.enabled"

src/support/php.ts

@@ -211,8 +211,6 @@ export const runInLaravel = <T>(
 
     const command = template("bootstrapLaravel", {
         output: code,
-        vendor_autoload_path: projectPath("vendor/autoload.php", true),
-        bootstrap_path: projectPath("bootstrap/app.php", true),
     });
 
     return runPhp(command, description)

src/support/project.ts

@@ -1,6 +1,7 @@
 import * as fs from "fs";
 import * as path from "path";
 import * as vscode from "vscode";
+import { config } from "./config";
 
 let internalVendorExists: boolean | null = null;
 
@@ -28,26 +29,19 @@ const trimFirstSlash = (srcPath: string): string => {
     return srcPath[0] === path.sep ? srcPath.substring(1) : srcPath;
 };
 
-export const projectPath = (srcPath = "", forCode = false): string => {
-    srcPath = srcPath.replace(/\//g, path.sep);
-    srcPath = trimFirstSlash(srcPath);
-
-    let basePath = "";
-    // let basePath = config<string>("basePath", "");
-
-    if (forCode === false && basePath.length > 0) {
-        return resolvePath(basePath, srcPath);
-    }
-
-    let basePathForCode = "";
-    // let basePathForCode = config<string>("basePathForCode", "");
+export const basePath = (srcPath = ""): string => {
+    return path.join(config<string>("basePath", ""), srcPath);
+};
 
-    if (forCode && basePathForCode.length > 0) {
-        return resolvePath(basePathForCode, srcPath);
-    }
+export const projectPath = (srcPath = ""): string => {
+    srcPath = basePath(srcPath);
 
     for (let workspaceFolder of getWorkspaceFolders()) {
-        if (fs.existsSync(path.join(workspaceFolder.uri.fsPath, "artisan"))) {
+        if (
+            fs.existsSync(
+                path.join(workspaceFolder.uri.fsPath, basePath("artisan")),
+            )
+        ) {
             return path.join(workspaceFolder.uri.fsPath, srcPath);
         }
     }
@@ -59,7 +53,10 @@ export const relativePath = (srcPath: string): string => {
     for (let workspaceFolder of getWorkspaceFolders()) {
         if (srcPath.startsWith(workspaceFolder.uri.fsPath)) {
             return trimFirstSlash(
-                srcPath.replace(workspaceFolder.uri.fsPath, ""),
+                srcPath.replace(
+                    path.join(workspaceFolder.uri.fsPath, basePath()),
+                    "",
+                ),
             );
         }
     }