feat: Add limited support for virtual workspaces (#930)

zobo · web-flow · commit 3025d1f01b5b · 2023-11-07T15:34:38.000+01:00
* Add limited support for virtual workspaces. Override ${workspaceFolder} variable substitution.

* Do not show run/debug menu icon when on virtual FS. Change deprecated ${workspaceRoot} default.

* Prepare replace for currently un-mapped configuration variables.

* CHANGELOG
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [1.34.0]
+
+- Partial support for virtual workspaces
+
 ## [1.33.1]
 
 - Fix editor title run/debug button.
diff --git a/package.json b/package.json
@@ -165,6 +165,10 @@
       "restrictedConfigurations": [
         "php.debug.executablePath"
       ]
+    },
+    "virtualWorkspaces": {
+      "supported": "limited",
+      "description": "In virtual workspaces, PHP process cannot be started, but can listen for incoming connections."
     }
   },
   "contributes": {
@@ -211,7 +215,7 @@
               "cwd": {
                 "type": "string",
                 "description": "Absolute path to the working directory of the program being debugged. Default is the current workspace.",
-                "default": "${workspaceRoot}"
+                "default": "${workspaceFolder}"
               },
               "runtimeExecutable": {
                 "type": "string",
@@ -527,23 +531,23 @@
       "editor/title/run": [
         {
           "command": "extension.php-debug.runEditorContents",
-          "when": "resourceLangId == php && !inDiffEditor",
+          "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file",
           "group": "navigation@1"
         },
         {
           "command": "extension.php-debug.debugEditorContents",
-          "when": "resourceLangId == php && !inDiffEditor",
+          "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file",
           "group": "navigation@2"
         }
       ],
       "commandPalette": [
         {
           "command": "extension.php-debug.debugEditorContents",
-          "when": "resourceLangId == php && !inDiffEditor"
+          "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file"
         },
         {
           "command": "extension.php-debug.runEditorContents",
-          "when": "resourceLangId == php && !inDiffEditor"
+          "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file"
         }
       ]
     },
diff --git a/src/extension.ts b/src/extension.ts
@@ -71,6 +71,29 @@ export function activate(context: vscode.ExtensionContext) {
                         }
                     }
                 }
+                if (folder && folder.uri.scheme !== 'file') {
+                    // replace
+                    if (debugConfiguration.pathMappings) {
+                        for (const key in debugConfiguration.pathMappings) {
+                            debugConfiguration.pathMappings[key] = debugConfiguration.pathMappings[key].replace(
+                                '${workspaceFolder}',
+                                folder.uri.toString()
+                            )
+                        }
+                    }
+                    // The following path are currently NOT mapped
+                    /*
+                    debugConfiguration.skipEntryPaths = debugConfiguration.skipEntryPaths?.map(v =>
+                        v.replace('${workspaceFolder}', folder.uri.toString())
+                    )
+                    debugConfiguration.skipFiles = debugConfiguration.skipFiles?.map(v =>
+                        v.replace('${workspaceFolder}', folder.uri.toString())
+                    )
+                    debugConfiguration.ignore = debugConfiguration.ignore?.map(v =>
+                        v.replace('${workspaceFolder}', folder.uri.toString())
+                    )
+                    */
+                }
                 return debugConfiguration
             },
         })

Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,10 @@`
`165`	`165`	`"restrictedConfigurations": [`
`166`	`166`	`"php.debug.executablePath"`
`167`	`167`	`]`
	`168`	`+ },`
	`169`	`+ "virtualWorkspaces": {`
	`170`	`+ "supported": "limited",`
	`171`	`+ "description": "In virtual workspaces, PHP process cannot be started, but can listen for incoming connections."`
`168`	`172`	`}`
`169`	`173`	`},`
`170`	`174`	`"contributes": {`
`@@ -211,7 +215,7 @@`
`211`	`215`	`"cwd": {`
`212`	`216`	`"type": "string",`
`213`	`217`	`"description": "Absolute path to the working directory of the program being debugged. Default is the current workspace.",`
`214`		`- "default": "${workspaceRoot}"`
	`218`	`+ "default": "${workspaceFolder}"`
`215`	`219`	`},`
`216`	`220`	`"runtimeExecutable": {`
`217`	`221`	`"type": "string",`
`@@ -527,23 +531,23 @@`
`527`	`531`	`"editor/title/run": [`
`528`	`532`	`{`
`529`	`533`	`"command": "extension.php-debug.runEditorContents",`
`530`		`- "when": "resourceLangId == php && !inDiffEditor",`
	`534`	`+ "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file",`
`531`	`535`	`"group": "navigation@1"`
`532`	`536`	`},`
`533`	`537`	`{`
`534`	`538`	`"command": "extension.php-debug.debugEditorContents",`
`535`		`- "when": "resourceLangId == php && !inDiffEditor",`
	`539`	`+ "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file",`
`536`	`540`	`"group": "navigation@2"`
`537`	`541`	`}`
`538`	`542`	`],`
`539`	`543`	`"commandPalette": [`
`540`	`544`	`{`
`541`	`545`	`"command": "extension.php-debug.debugEditorContents",`
`542`		`- "when": "resourceLangId == php && !inDiffEditor"`
	`546`	`+ "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file"`
`543`	`547`	`},`
`544`	`548`	`{`
`545`	`549`	`"command": "extension.php-debug.runEditorContents",`
`546`		`- "when": "resourceLangId == php && !inDiffEditor"`
	`550`	`+ "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file"`
`547`	`551`	`}`
`548`	`552`	`]`
`549`	`553`	`},`