Add a serverReadyAction.action to open the URI in the Viewer pane (#4554)

Addresses #4553. See the
issue for QA notes.

Author: seeM

extensions/debug-server-ready/package.json

@@ -72,6 +72,43 @@
                       }
                     }
                   },
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "markdownDescription": "%debug.server.ready.serverReadyAction.description%",
+                    "default": {
+                      "action": "openInViewer",
+                      "killOnServerStop": false
+                    },
+                    "properties": {
+                      "action": {
+                        "type": "string",
+                        "enum": [
+                          "openInViewer"
+                        ],
+                        "enumDescriptions": [
+                          "%debug.server.ready.action.openInViewer.description%"
+                        ],
+                        "markdownDescription": "%debug.server.ready.action.description%",
+                        "default": "openInViewer"
+                      },
+                      "pattern": {
+                        "type": "string",
+                        "markdownDescription": "%debug.server.ready.pattern.description%",
+                        "default": "listening on port ([0-9]+)"
+                      },
+                      "uriFormat": {
+                        "type": "string",
+                        "markdownDescription": "%debug.server.ready.uriFormat.description%",
+                        "default": "http://localhost:%s"
+                      },
+                      "killOnServerStop": {
+                        "type": "boolean",
+                        "markdownDescription": "%debug.server.ready.killOnServerStop.description%",
+                        "default": false
+                      }
+                    }
+                  },
                   {
                     "type": "object",
                     "additionalProperties": false,

extensions/debug-server-ready/package.nls.json

@@ -5,6 +5,7 @@
 	"debug.server.ready.serverReadyAction.description": "Act upon a URI when a server program under debugging is ready (indicated by sending output of the form 'listening on port 3000' or 'Now listening on: https://localhost:5001' to the debug console.)",
 	"debug.server.ready.action.description": "What to do with the URI when the server is ready.",
 	"debug.server.ready.action.openExternally.description": "Open URI externally with the default application.",
+	"debug.server.ready.action.openInViewer.description": "Open URI in the Viewer pane.",
 	"debug.server.ready.action.debugWithChrome.description": "Start debugging with the 'Debugger for Chrome'.",
 	"debug.server.ready.action.startDebugging.description": "Run another launch configuration.",
 	"debug.server.ready.pattern.description": "Server is ready if this pattern appears on the debug console. The first capture group must include a URI or a port number.",

extensions/debug-server-ready/src/extension.ts

@@ -6,6 +6,9 @@
 import * as vscode from 'vscode';
 import * as util from 'util';
 import { randomUUID } from 'crypto';
+// --- Start Positron ---
+import * as positron from 'positron';
+// --- End Positron ---
 
 const PATTERN = 'listening on.* (https?://\\S+|[0-9]+)'; // matches "listening on port 3000" or "Now listening on: https://localhost:5001"
 const URI_PORT_FORMAT = 'http://localhost:%s';
@@ -14,7 +17,10 @@ const WEB_ROOT = '${workspaceFolder}';
 
 interface ServerReadyAction {
 	pattern: string;
-	action?: 'openExternally' | 'debugWithChrome' | 'debugWithEdge' | 'startDebugging';
+	// --- Start Positron ---
+	// Add an action to open the URI in the Viewer pane.
+	action?: 'openExternally' | 'openInViewer' | 'debugWithChrome' | 'debugWithEdge' | 'startDebugging';
+	// --- End Positron ---
 	uriFormat?: string;
 	webRoot?: string;
 	name?: string;
@@ -201,6 +207,12 @@ class ServerReadyDetector extends vscode.Disposable {
 					await this.startDebugSession(session, args.name || 'unspecified');
 				}
 				break;
+			// --- Start Positron ---
+			// Open the URI in the Viewer pane.
+			case 'openInViewer':
+				positron.window.previewUrl(vscode.Uri.parse(uri));
+				break;
+			// --- End Positron ---
 
 			default:
 				// not supported

extensions/debug-server-ready/tsconfig.json

@@ -11,5 +11,8 @@
 		"src/**/*",
 		"../../src/vscode-dts/vscode.d.ts",
 		"../../src/vscode-dts/vscode.proposed.terminalDataWriteEvent.d.ts",
+		// --- Start Positron ---
+		"../../src/positron-dts/positron.d.ts",
+		// --- End Positron ---
 	]
 }