feat(rush-serve): log dashboard URL

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: bmiddha

common/changes/@microsoft/rush/rush-serve-dashboard-select-all_2026-08-07-15-26-00.json

@@ -2,7 +2,7 @@
   "changes": [
     {
       "packageName": "@microsoft/rush",
-      "comment": "Allow Ctrl+A and Command+A to select text in Rush serve dashboard fields.",
+      "comment": "Allow Ctrl+A and Command+A to select text in Rush serve dashboard fields, and log a clickable dashboard URL when the server starts.",
       "type": "patch"
     }
   ],

common/config/rush-plugins/rush-serve-plugin.json

@@ -3,6 +3,7 @@
   "phasedCommands": ["start"],
   "portParameterLongName": "--port",
   "buildStatusWebSocketPath": "/ws",
+  "dashboardServePath": "/dashboard/dashboard.html",
   "logServePath": "/logs",
   "globalRouting": [
     {

rush-plugins/rush-serve-plugin/README.md

@@ -29,6 +29,7 @@ This package includes the reference `@rushstack/rush-serve-dashboard` web app, w
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-serve-plugin-options.schema.json",
   "phasedCommands": ["start"],
   "buildStatusWebSocketPath": "/ws",
+  "dashboardServePath": "/dashboard/dashboard.html",
   "globalRouting": [
     {
       "workspaceRelativeFolder": "rush-plugins/rush-serve-plugin/lib-esm/dashboard",
@@ -39,7 +40,8 @@ This package includes the reference `@rushstack/rush-serve-dashboard` web app, w
 }
 ```
 
-Then open `https://localhost:<port>/dashboard/dashboard.html`.
+After the server starts, the plugin logs a clickable dashboard URL such as
+`https://localhost:<port>/dashboard/dashboard.html`.
 
 ### Dashboard
 

rush-plugins/rush-serve-plugin/src/RushServePlugin.ts

@@ -31,6 +31,12 @@ export interface IRushServePluginOptions {
    */
   buildStatusWebSocketPath?: string;
 
+  /**
+   * The URL path for the Rush serve dashboard. If specified, the plugin logs the full dashboard URL
+   * after the server starts.
+   */
+  dashboardServePath?: string;
+
   /**
    * The name of a parameter that Rush is configured to use to pass a port number to underlying operations.
    * If specified, the plugin will ensure the value is synchronized with the port used for its server.
@@ -59,20 +65,23 @@ export class RushServePlugin implements IRushPlugin {
   private readonly _globalRoutingRules: IGlobalRoutingRuleJson[];
   private readonly _logServePath: string | undefined;
   private readonly _buildStatusWebSocketPath: string | undefined;
+  private readonly _dashboardServePath: string | undefined;
 
   public constructor(options: IRushServePluginOptions) {
     const {
       phasedCommands,
       portParameterLongName,
       globalRouting = [],
       logServePath,
-      buildStatusWebSocketPath
+      buildStatusWebSocketPath,
+      dashboardServePath
     } = options;
     this._phasedCommands = new Set(phasedCommands);
     this._portParameterLongName = portParameterLongName;
     this._globalRoutingRules = globalRouting;
     this._logServePath = logServePath;
     this._buildStatusWebSocketPath = buildStatusWebSocketPath;
+    this._dashboardServePath = dashboardServePath;
   }
 
   public apply(rushSession: RushSession, rushConfiguration: RushConfiguration): void {
@@ -100,7 +109,8 @@ export class RushServePlugin implements IRushPlugin {
         portParameterLongName: this._portParameterLongName,
         logServePath: this._logServePath,
         globalRoutingRules,
-        buildStatusWebSocketPath: this._buildStatusWebSocketPath
+        buildStatusWebSocketPath: this._buildStatusWebSocketPath,
+        dashboardServePath: this._dashboardServePath
       });
     };
 

rush-plugins/rush-serve-plugin/src/phasedCommandHandler.ts

@@ -31,8 +31,16 @@ import {
   type WebSocketServerUpgrader
 } from './tryEnableBuildStatusWebSocketServer';
 
+export function getServerUrls(
+  hostNames: readonly string[],
+  port: number,
+  servePath: string
+): string[] {
+  return hostNames.map((hostName) => `https://${hostName}:${port}${servePath}`);
+}
+
 export async function phasedCommandHandler(options: IPhasedCommandHandlerOptions): Promise<void> {
-  const { rushSession, command, portParameterLongName, globalRoutingRules } = options;
+  const { rushSession, command, portParameterLongName, globalRoutingRules, dashboardServePath } = options;
 
   const logger: ILogger = rushSession.getLogger(PLUGIN_NAME);
 
@@ -44,10 +52,15 @@ export async function phasedCommandHandler(options: IPhasedCommandHandlerOptions
   function logHost(): void {
     if (activePort !== undefined) {
       logger.terminal.writeLine(
-        `Content is being served from:\n  ${activeHostNames
-          .map((hostName) => `https://${hostName}:${activePort}/`)
-          .join('\n  ')}`
+        `Content is being served from:\n  ${getServerUrls(activeHostNames, activePort, '/').join('\n  ')}`
       );
+      if (dashboardServePath) {
+        logger.terminal.writeLine(
+          `Rush serve dashboard:\n  ${getServerUrls(activeHostNames, activePort, dashboardServePath).join(
+            '\n  '
+          )}`
+        );
+      }
     }
   }
 

rush-plugins/rush-serve-plugin/src/schemas/rush-serve-plugin-options.schema.json

@@ -33,6 +33,12 @@
       "pattern": "^/(?:[a-zA-Z0-9_$-]+(?:/[a-zA-Z0-9_$-]+)*)?$"
     },
 
+    "dashboardServePath": {
+      "type": "string",
+      "description": "The URL path for the Rush serve dashboard. If specified, the plugin logs the full dashboard URL after the server starts.",
+      "pattern": "^/(?:[a-zA-Z0-9_.$-]+(?:/[a-zA-Z0-9_.$-]+)*)?$"
+    },
+
     "logServePath": {
       "type": "string",
       "description": "The URL path at which to host Rush log files. If not specified, log files will not be served.",

rush-plugins/rush-serve-plugin/src/test/Server.test.ts

@@ -1,8 +1,13 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
+import { getServerUrls } from '../phasedCommandHandler';
+
 describe('Server', () => {
-  it('Is not implemented yet.', () => {
-    // Do nothing.
+  it('formats clickable serve URLs', () => {
+    expect(getServerUrls(['localhost', 'rushstack.test'], 8091, '/dashboard/dashboard.html')).toEqual([
+      'https://localhost:8091/dashboard/dashboard.html',
+      'https://rushstack.test:8091/dashboard/dashboard.html'
+    ]);
   });
 });

rush-plugins/rush-serve-plugin/src/types.ts

@@ -11,6 +11,7 @@ export interface IPhasedCommandHandlerOptions {
   logServePath: string | undefined;
   globalRoutingRules: IRoutingRule[];
   buildStatusWebSocketPath: string | undefined;
+  dashboardServePath: string | undefined;
 }
 export interface IRushProjectServeJson {
   routing: IRoutingRuleJson[];