Merge pull request #72 from dave-se/add_path_separator

feat: add pathSeparator option to control debugger path normalization

Author: softwareCobbler

readme.md

@@ -134,11 +134,20 @@ A CFML debug configuration looks like:
         "idePrefix": "${workspaceFolder}",
         "serverPrefix": "/app"
       }
-    ]
+    ],
+    // optional; controls how paths returned from the debugger are normalized in the client.
+    // options:
+    //   "none"    - (default) no normalization; use paths exactly as returned from the debugger
+    //   "auto"    - use the platform default (e.g., "/" on macOS/Linux, "\" on Windows)
+    //   "posix"   - always use forward slashes ("/")
+    //   "windows" - always use backslashes ("\")
+    "pathSeparator": "auto"
 }
 ```
 `hostName`/`port` should match the `debugHost`/`debugPort` of the Java agent's configuration. (There are exceptions; e.g., on remote hosts where DNS and/or port forwarding are in play.)
 
+Use the `pathSeparator` option to control how file paths returned from the server are interpreted on your client machine. This is useful when debugging across different operating systems or dealing with platform-specific path formats.
+
 #### Mapping Paths with `pathTransforms`
 
 

vscode-client/package-lock.json

@@ -125,6 +125,12 @@
                     "serverPrefix": "/container-root/app"
                   }
                 ]
+              },
+              "pathSeparator": {
+                "type": "string",
+                "enum": ["none", "auto", "posix", "windows"],
+                "default": "auto",
+                "description": "How paths returned from the debugger should be normalized (none, auto, posix, or windows)."
               }
             }
           }
@@ -141,6 +147,7 @@
                 "serverPrefix": "/app"
               }
             ],
+            "pathSeparator": "auto",
             "port": 8000
           }
         ],
@@ -159,6 +166,7 @@
                   "serverPrefix": "/app"
                 }
               ],
+              "pathSeparator": "auto",
               "port": 8000
             }
           }

vscode-client/package.json

@@ -64,6 +64,19 @@ export function activate(context: vscode.ExtensionContext) {
 		}
 	}
 
+	const normalizePathFromSession = (session: vscode.DebugSession, path: string): string => {
+		const pathSeparator = session.configuration?.pathSeparator ?? "auto";
+		if (pathSeparator === "none") return path;
+
+		const platformDefault = process.platform === "win32" ? "\\" : "/";
+		const normalizedSeparator = pathSeparator === "posix"
+			? "/"
+			: pathSeparator === "windows"
+			? "\\"
+			: platformDefault;
+		return path.replace(/[\\/]/g, normalizedSeparator);
+	};
+
 	context.subscriptions.push(
 		vscode.commands.registerCommand("luceedebug.dump", async (args?: Partial<DebugPaneContextMenuArgs>) => {
 			if (args?.variable === undefined || args.variable.variablesReference === 0) {
@@ -219,6 +232,13 @@ export function activate(context: vscode.ExtensionContext) {
 					outputChannel.append(JSON.stringify(message, null, 4) + "\n");
 				},
 				onDidSendMessage(message: any) : void {
+					if (message.command === "stackTrace" || (message.type === "response" && message.body?.stackFrames)) {
+						for (const frame of message.body.stackFrames) {
+							if (frame.source?.path) {
+								frame.source.path = normalizePathFromSession(session, frame.source.path);
+							}
+						}
+					}
 					outputChannel.append(JSON.stringify(message, null, 4) + "\n");
 				}
 			}